diff --git a/.gitignore b/.gitignore
index 64c3de539e2..47e425eab74 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,7 +31,7 @@ node_modules/
# virtual envs
vv
-venv
+venv*
# dist files
build
diff --git a/packages/python/plotly/_plotly_utils/exceptions.py b/packages/python/plotly/_plotly_utils/exceptions.py
index c1a2d6b368e..7a9174eb1ef 100644
--- a/packages/python/plotly/_plotly_utils/exceptions.py
+++ b/packages/python/plotly/_plotly_utils/exceptions.py
@@ -83,3 +83,14 @@ def __init__(self, obj, path, notes=()):
super(PlotlyDataTypeError, self).__init__(
message=message, path=path, notes=notes
)
+
+
+class PlotlyKeyError(LookupError):
+ """
+ KeyErrors are not printed as beautifully as other errors (this is so that
+ {}[''] prints "KeyError: ''" and not "KeyError:"). So here we subclass
+ LookupError to make a PlotlyKeyError object which will print nicer error
+ messages for KeyErrors.
+ """
+
+ pass
diff --git a/packages/python/plotly/_plotly_utils/utils.py b/packages/python/plotly/_plotly_utils/utils.py
index cbf8d3a6b98..5deead650b1 100644
--- a/packages/python/plotly/_plotly_utils/utils.py
+++ b/packages/python/plotly/_plotly_utils/utils.py
@@ -2,6 +2,7 @@
import json as _json
import sys
import re
+from functools import reduce
from _plotly_utils.optional_imports import get_module
from _plotly_utils.basevalidators import ImageUriValidator
@@ -10,6 +11,20 @@
PY36_OR_LATER = sys.version_info >= (3, 6)
+def cumsum(x):
+ """
+ Custom cumsum to avoid a numpy import.
+ """
+
+ def _reducer(a, x):
+ if len(a) == 0:
+ return [x]
+ return a + [a[-1] + x]
+
+ ret = reduce(_reducer, x, [])
+ return ret
+
+
class PlotlyJSONEncoder(_json.JSONEncoder):
"""
Meant to be passed as the `cls` kwarg to json.dumps(obj, cls=..)
@@ -256,3 +271,76 @@ def _get_int_type():
else:
int_type = (int,)
return int_type
+
+
+def split_multichar(ss, chars):
+ """
+ Split all the strings in ss at any of the characters in chars.
+ Example:
+
+ >>> ss = ["a.string[0].with_separators"]
+ >>> chars = list(".[]_")
+ >>> split_multichar(ss, chars)
+ ['a', 'string', '0', '', 'with', 'separators']
+
+ :param (list) ss: A list of strings.
+ :param (list) chars: Is a list of chars (note: not a string).
+ """
+ if len(chars) == 0:
+ return ss
+ c = chars.pop()
+ ss = reduce(lambda x, y: x + y, map(lambda x: x.split(c), ss))
+ return split_multichar(ss, chars)
+
+
+def split_string_positions(ss):
+ """
+ Given a list of strings split using split_multichar, return a list of
+ integers representing the indices of the first character of every string in
+ the original string.
+ Example:
+
+ >>> ss = ["a.string[0].with_separators"]
+ >>> chars = list(".[]_")
+ >>> ss_split = split_multichar(ss, chars)
+ >>> ss_split
+ ['a', 'string', '0', '', 'with', 'separators']
+ >>> split_string_positions(ss_split)
+ [0, 2, 9, 11, 12, 17]
+
+ :param (list) ss: A list of strings.
+ """
+ return list(
+ map(
+ lambda t: t[0] + t[1],
+ zip(range(len(ss)), cumsum([0] + list(map(len, ss[:-1])))),
+ )
+ )
+
+
+def display_string_positions(p, i=None):
+ """
+ Return a string that is whitespace except at p[i] which is replaced with ^.
+ If i is None then all the indices of the string in p are replaced with ^.
+ Example:
+
+ >>> ss = ["a.string[0].with_separators"]
+ >>> chars = list(".[]_")
+ >>> ss_split = split_multichar(ss, chars)
+ >>> ss_split
+ ['a', 'string', '0', '', 'with', 'separators']
+ >>> ss_pos = split_string_positions(ss_split)
+ >>> ss[0]
+ 'a.string[0].with_separators'
+ >>> display_string_positions(ss_pos,4)
+ ' ^'
+ :param (list) p: A list of integers.
+ :param (integer|None) i: Optional index of p to display.
+ """
+ s = [" " for _ in range(max(p) + 1)]
+ if i is None:
+ for p_ in p:
+ s[p_] = "^"
+ else:
+ s[p[i]] = "^"
+ return "".join(s)
diff --git a/packages/python/plotly/plotly/basedatatypes.py b/packages/python/plotly/plotly/basedatatypes.py
index 7bc0e66f56d..d4f1c6f3d79 100644
--- a/packages/python/plotly/plotly/basedatatypes.py
+++ b/packages/python/plotly/plotly/basedatatypes.py
@@ -9,7 +9,14 @@
from contextlib import contextmanager
from copy import deepcopy, copy
-from _plotly_utils.utils import _natural_sort_strings, _get_int_type
+from _plotly_utils.utils import (
+ _natural_sort_strings,
+ _get_int_type,
+ split_multichar,
+ split_string_positions,
+ display_string_positions,
+)
+from _plotly_utils.exceptions import PlotlyKeyError
from .optional_imports import get_module
# Create Undefined sentinel value
@@ -18,6 +25,124 @@
Undefined = object()
+def _str_to_dict_path_full(key_path_str):
+ """
+ Convert a key path string into a tuple of key path elements and also
+ return a tuple of indices marking the beginning of each element in the
+ string.
+
+ Parameters
+ ----------
+ key_path_str : str
+ Key path string, where nested keys are joined on '.' characters
+ and array indexes are specified using brackets
+ (e.g. 'foo.bar[1]')
+ Returns
+ -------
+ tuple[str | int]
+ tuple [int]
+ """
+ key_path2 = split_multichar([key_path_str], list(".[]"))
+ # Split out underscore
+ # e.g. ['foo', 'bar_baz', '1'] -> ['foo', 'bar', 'baz', '1']
+ key_path3 = []
+ underscore_props = BaseFigure._valid_underscore_properties
+
+ def _make_hyphen_key(key):
+ if "_" in key[1:]:
+ # For valid properties that contain underscores (error_x)
+ # replace the underscores with hyphens to protect them
+ # from being split up
+ for under_prop, hyphen_prop in underscore_props.items():
+ key = key.replace(under_prop, hyphen_prop)
+ return key
+
+ def _make_underscore_key(key):
+ return key.replace("-", "_")
+
+ key_path2b = map(_make_hyphen_key, key_path2)
+ key_path2c = split_multichar(key_path2b, list("_"))
+ key_path2d = list(map(_make_underscore_key, key_path2c))
+ all_elem_idcs = tuple(split_string_positions(list(key_path2d)))
+ # remove empty strings, and indices pointing to them
+ key_elem_pairs = list(filter(lambda t: len(t[1]), enumerate(key_path2d)))
+ key_path3 = [x for _, x in key_elem_pairs]
+ elem_idcs = [all_elem_idcs[i] for i, _ in key_elem_pairs]
+
+ # Convert elements to ints if possible.
+ # e.g. ['foo', 'bar', '0'] -> ['foo', 'bar', 0]
+ for i in range(len(key_path3)):
+ try:
+ key_path3[i] = int(key_path3[i])
+ except ValueError as _:
+ pass
+
+ return (tuple(key_path3), elem_idcs)
+
+
+def _remake_path_from_tuple(props):
+ """
+ try to remake a path using the properties in props
+ """
+ if len(props) == 0:
+ return ""
+
+ def _add_square_brackets_to_number(n):
+ if type(n) == type(int()):
+ return "[%d]" % (n,)
+ return n
+
+ def _prepend_dot_if_not_number(s):
+ if not s.startswith("["):
+ return "." + s
+ return s
+
+ props_all_str = list(map(_add_square_brackets_to_number, props))
+ props_w_underscore = props_all_str[:1] + list(
+ map(_prepend_dot_if_not_number, props_all_str[1:])
+ )
+ return "".join(props_w_underscore)
+
+
+def _check_path_in_prop_tree(obj, path):
+ """
+ obj: the object in which the first property is looked up
+ path: the path that will be split into properties to be looked up
+ path can also be a tuple. In this case, it is combined using . and []
+ because it is impossible to reconstruct the string fully in order to
+ give a decent error message.
+ returns
+ an Exception object or None. The caller can raise this
+ exception to see where the lookup error occurred.
+ """
+ if type(path) == type(tuple()):
+ path = _remake_path_from_tuple(path)
+ prop, prop_idcs = _str_to_dict_path_full(path)
+ for i, p in enumerate(prop):
+ try:
+ obj = obj[p]
+ except (ValueError, KeyError, IndexError) as e:
+ arg = (
+ e.args[0]
+ + """
+Bad property path:
+%s"""
+ % (path,)
+ )
+ arg += """
+%s""" % (
+ display_string_positions(prop_idcs, i),
+ )
+ # Make KeyError more pretty by changing it to a PlotlyKeyError,
+ # because the Python interpreter has a special way of printing
+ # KeyError
+ if type(e) == type(KeyError()):
+ e = PlotlyKeyError()
+ e.args = (arg,)
+ return e
+ return None
+
+
class BaseFigure(object):
"""
Base class for all figure types (both widget and non-widget)
@@ -265,10 +390,18 @@ class is a subclass of both BaseFigure and widgets.DOMWidget.
# Process kwargs
# --------------
for k, v in kwargs.items():
- if k in self:
+ err = _check_path_in_prop_tree(self, k)
+ if err is None:
self[k] = v
elif not skip_invalid:
- raise TypeError("invalid Figure property: {}".format(k))
+ type_err = TypeError("invalid Figure property: {}".format(k))
+ type_err.args = (
+ type_err.args[0]
+ + """
+%s"""
+ % (err.args[0],),
+ )
+ raise type_err
# Magic Methods
# -------------
@@ -315,6 +448,9 @@ def __setitem__(self, prop, value):
# ----------------------
# e.g. ('foo', 1)
else:
+ err = _check_path_in_prop_tree(self, orig_prop)
+ if err is not None:
+ raise err
res = self
for p in prop[:-1]:
res = res[p]
@@ -370,6 +506,9 @@ def __getitem__(self, prop):
# ----------------------
# e.g. ('foo', 1)
else:
+ err = _check_path_in_prop_tree(self, orig_prop)
+ if err is not None:
+ raise err
res = self
for p in prop:
res = res[p]
@@ -1337,7 +1476,7 @@ def _normalize_trace_indexes(self, trace_indexes):
@staticmethod
def _str_to_dict_path(key_path_str):
"""
- Convert a key path string into a tuple of key path elements
+ Convert a key path string into a tuple of key path elements.
Parameters
----------
@@ -1361,53 +1500,8 @@ def _str_to_dict_path(key_path_str):
# Nothing to do
return key_path_str
else:
- # Split string on periods.
- # e.g. 'foo.bar_baz[1]' -> ['foo', 'bar_baz[1]']
- key_path = key_path_str.split(".")
-
- # Split out bracket indexes.
- # e.g. ['foo', 'bar_baz[1]'] -> ['foo', 'bar_baz', '1']
- key_path2 = []
- for key in key_path:
- match = BaseFigure._bracket_re.match(key)
- if match:
- key_path2.extend(match.groups())
- else:
- key_path2.append(key)
-
- # Split out underscore
- # e.g. ['foo', 'bar_baz', '1'] -> ['foo', 'bar', 'baz', '1']
- key_path3 = []
- underscore_props = BaseFigure._valid_underscore_properties
- for key in key_path2:
- if "_" in key[1:]:
- # For valid properties that contain underscores (error_x)
- # replace the underscores with hyphens to protect them
- # from being split up
- for under_prop, hyphen_prop in underscore_props.items():
- key = key.replace(under_prop, hyphen_prop)
-
- # Split key on underscores
- key = key.split("_")
-
- # Replace hyphens with underscores to restore properties
- # that include underscores
- for i in range(len(key)):
- key[i] = key[i].replace("-", "_")
-
- key_path3.extend(key)
- else:
- key_path3.append(key)
-
- # Convert elements to ints if possible.
- # e.g. ['foo', 'bar', '0'] -> ['foo', 'bar', 0]
- for i in range(len(key_path3)):
- try:
- key_path3[i] = int(key_path3[i])
- except ValueError as _:
- pass
-
- return tuple(key_path3)
+ ret = _str_to_dict_path_full(key_path_str)[0]
+ return ret
@staticmethod
def _set_in(d, key_path_str, v):
@@ -3320,19 +3414,20 @@ def _perform_update(plotly_obj, update_obj, overwrite=False):
# -------------------------------
# This should be valid even if xaxis2 hasn't been initialized:
# >>> layout.update(xaxis2={'title': 'xaxis 2'})
- if isinstance(plotly_obj, BaseLayoutType):
- for key in update_obj:
- if key not in plotly_obj:
+ for key in update_obj:
+ err = _check_path_in_prop_tree(plotly_obj, key)
+ if err is not None:
+ if isinstance(plotly_obj, BaseLayoutType):
+ # try _subplot_re_match
match = plotly_obj._subplot_re_match(key)
if match:
# We need to create a subplotid object
plotly_obj[key] = {}
-
- # Handle invalid properties
- # -------------------------
- invalid_props = [k for k in update_obj if k not in plotly_obj]
-
- plotly_obj._raise_on_invalid_property_error(*invalid_props)
+ continue
+ # If no match, raise the error, which should already
+ # contain the _raise_on_invalid_property_error
+ # generated message
+ raise err
# Convert update_obj to dict
# --------------------------
@@ -3536,17 +3631,20 @@ def _process_kwargs(self, **kwargs):
"""
invalid_kwargs = {}
for k, v in kwargs.items():
- if k in self:
+ err = _check_path_in_prop_tree(self, k)
+ if err is None:
# e.g. underscore kwargs like marker_line_color
self[k] = v
elif not self._validate:
# Set extra property as-is
self[k] = v
- else:
- invalid_kwargs[k] = v
-
- if invalid_kwargs and not self._skip_invalid:
- self._raise_on_invalid_property_error(*invalid_kwargs.keys())
+ elif not self._skip_invalid:
+ raise err
+ # No need to call _raise_on_invalid_property_error here,
+ # because we have it set up so that the singular case of calling
+ # __setitem__ will raise this. If _check_path_in_prop_tree
+ # raised that in its travels, it will already be in the error
+ # message.
@property
def plotly_name(self):
@@ -3852,12 +3950,14 @@ def __getitem__(self, prop):
# Normalize prop
# --------------
# Convert into a property tuple
+ orig_prop = prop
prop = BaseFigure._str_to_dict_path(prop)
# Handle remapping
# ----------------
if prop and prop[0] in self._mapped_properties:
prop = self._mapped_properties[prop[0]] + prop[1:]
+ orig_prop = _remake_path_from_tuple(prop)
# Handle scalar case
# ------------------
@@ -3866,7 +3966,7 @@ def __getitem__(self, prop):
# Unwrap scalar tuple
prop = prop[0]
if prop not in self._valid_props:
- raise KeyError(prop)
+ self._raise_on_invalid_property_error(prop)
validator = self._get_validator(prop)
@@ -3904,6 +4004,9 @@ def __getitem__(self, prop):
# ----------------------
# e.g. ('foo', 1), ()
else:
+ err = _check_path_in_prop_tree(self, orig_prop)
+ if err is not None:
+ raise err
res = self
for p in prop:
res = res[p]
@@ -3932,6 +4035,9 @@ def __contains__(self, prop):
-------
bool
"""
+ # TODO: We don't want to throw an error in __contains__ because any code that
+ # relies on it returning False will have to be changed (it will have to
+ # have a try except block...).
prop = BaseFigure._str_to_dict_path(prop)
# Handle remapping
@@ -4047,6 +4153,9 @@ def __setitem__(self, prop, value):
# ----------------------
# e.g. ('foo', 1), ()
else:
+ err = _check_path_in_prop_tree(self, orig_prop)
+ if err is not None:
+ raise err
res = self
for p in prop[:-1]:
res = res[p]
diff --git a/packages/python/plotly/plotly/graph_objs/_area.py b/packages/python/plotly/plotly/graph_objs/_area.py
index 00c8d29b4e4..e58951e48f6 100644
--- a/packages/python/plotly/plotly/graph_objs/_area.py
+++ b/packages/python/plotly/plotly/graph_objs/_area.py
@@ -43,7 +43,7 @@ def customdata(self):
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
@@ -64,7 +64,7 @@ def customdatasrc(self):
"""
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
@@ -86,7 +86,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -111,7 +111,7 @@ def hoverinfosrc(self):
"""
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
@@ -135,9 +135,9 @@ def hoverlabel(self):
- An instance of :class:`plotly.graph_objs.area.Hoverlabel`
- A dict of string/value properties that will be passed
to the Hoverlabel constructor
-
+
Supported dict properties:
-
+
align
Sets the horizontal alignment of the text
content within hover label box. Has an effect
@@ -192,7 +192,7 @@ def ids(self):
Assigns id labels to 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
@@ -212,7 +212,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -234,7 +234,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -259,9 +259,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.area.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Area traces are deprecated! Please switch to
the "barpolar" trace type. Sets themarkercolor.
@@ -324,7 +324,7 @@ def meta(self):
access trace `meta` 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
@@ -343,7 +343,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -364,7 +364,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -385,7 +385,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -407,7 +407,7 @@ def r(self):
Area traces are deprecated! Please switch to the "barpolar"
trace type. Sets the radial coordinates for legacy polar chart
only.
-
+
The 'r' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -427,7 +427,7 @@ def r(self, val):
def rsrc(self):
"""
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
@@ -448,7 +448,7 @@ def showlegend(self):
"""
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)
@@ -472,9 +472,9 @@ def stream(self):
- An instance of :class:`plotly.graph_objs.area.Stream`
- A dict of string/value properties that will be passed
to the Stream constructor
-
+
Supported dict properties:
-
+
maxpoints
Sets the maximum number of points to keep on
the plots from an incoming stream. If
@@ -503,7 +503,7 @@ def t(self):
Area traces are deprecated! Please switch to the "barpolar"
trace type. Sets the angular coordinates for legacy polar chart
only.
-
+
The 't' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -523,7 +523,7 @@ def t(self, val):
def tsrc(self):
"""
Sets the source reference on Chart Studio Cloud for t .
-
+
The 'tsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -544,7 +544,7 @@ def uid(self):
"""
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
@@ -579,7 +579,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -600,7 +600,7 @@ def visible(self):
Determines whether or not this 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']
@@ -758,7 +758,7 @@ def __init__(
):
"""
Construct a new Area object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/_bar.py b/packages/python/plotly/plotly/graph_objs/_bar.py
index 0638d41295a..b79ba6ba21b 100644
--- a/packages/python/plotly/plotly/graph_objs/_bar.py
+++ b/packages/python/plotly/plotly/graph_objs/_bar.py
@@ -91,7 +91,7 @@ def alignmentgroup(self):
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
@@ -114,7 +114,7 @@ def base(self):
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
@@ -133,7 +133,7 @@ def base(self, val):
def basesrc(self):
"""
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
@@ -156,7 +156,7 @@ def cliponaxis(self):
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)
@@ -177,7 +177,7 @@ def constraintext(self):
"""
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']
@@ -201,7 +201,7 @@ def customdata(self):
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
@@ -222,7 +222,7 @@ def customdatasrc(self):
"""
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
@@ -242,7 +242,7 @@ def customdatasrc(self, val):
def dx(self):
"""
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
@@ -262,7 +262,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -286,9 +286,9 @@ def error_x(self):
- 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
@@ -307,7 +307,7 @@ def error_x(self):
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
@@ -316,9 +316,9 @@ def error_x(self):
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
@@ -367,9 +367,9 @@ def error_y(self):
- 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
@@ -395,9 +395,9 @@ def error_y(self):
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
@@ -444,7 +444,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -469,7 +469,7 @@ def hoverinfosrc(self):
"""
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
@@ -493,9 +493,9 @@ def hoverlabel(self):
- 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
@@ -567,7 +567,7 @@ def hovertemplate(self):
displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -590,7 +590,7 @@ def hovertemplatesrc(self):
"""
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
@@ -614,7 +614,7 @@ def hovertext(self):
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
@@ -637,7 +637,7 @@ def hovertextsrc(self):
"""
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
@@ -659,7 +659,7 @@ def ids(self):
Assigns id labels to 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
@@ -679,7 +679,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -700,7 +700,7 @@ def insidetextanchor(self):
"""
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']
@@ -721,17 +721,17 @@ def insidetextanchor(self, val):
def insidetextfont(self):
"""
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 .
@@ -756,7 +756,7 @@ def insidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -779,7 +779,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -804,9 +804,9 @@ def marker(self):
- 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
@@ -927,7 +927,7 @@ def meta(self):
access trace `meta` 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
@@ -946,7 +946,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -967,7 +967,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -990,7 +990,7 @@ def offset(self):
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
@@ -1013,7 +1013,7 @@ def offsetgroup(self):
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
@@ -1034,7 +1034,7 @@ def offsetgroup(self, val):
def offsetsrc(self):
"""
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
@@ -1054,7 +1054,7 @@ def offsetsrc(self, val):
def opacity(self):
"""
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]
@@ -1075,7 +1075,7 @@ def orientation(self):
"""
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']
@@ -1096,17 +1096,17 @@ def orientation(self, val):
def outsidetextfont(self):
"""
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 .
@@ -1131,7 +1131,7 @@ def outsidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1154,7 +1154,7 @@ def r(self):
r coordinates in scatter traces are deprecated!Please switch to
the "scatterpolar" trace type.Sets the radial coordinatesfor
legacy polar chart only.
-
+
The 'r' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1174,7 +1174,7 @@ def r(self, val):
def rsrc(self):
"""
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
@@ -1198,9 +1198,9 @@ def selected(self):
- 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
@@ -1230,7 +1230,7 @@ def selectedpoints(self):
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
@@ -1250,7 +1250,7 @@ def showlegend(self):
"""
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)
@@ -1274,9 +1274,9 @@ def stream(self):
- 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
@@ -1305,7 +1305,7 @@ def t(self):
t coordinates in scatter traces are deprecated!Please switch to
the "scatterpolar" trace type.Sets the angular coordinatesfor
legacy polar chart only.
-
+
The 't' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1330,7 +1330,7 @@ def text(self):
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
@@ -1355,7 +1355,7 @@ def textangle(self):
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
@@ -1377,17 +1377,17 @@ def textangle(self, val):
def textfont(self):
"""
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 .
@@ -1412,7 +1412,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1439,7 +1439,7 @@ def textposition(self):
then the text gets pushed inside. "auto" tries to position
`text` inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside.
-
+
The 'textposition' property is an enumeration that may be specified as:
- One of the following enumeration values:
['inside', 'outside', 'auto', 'none']
@@ -1462,7 +1462,7 @@ def textpositionsrc(self):
"""
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
@@ -1482,7 +1482,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1515,7 +1515,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1538,7 +1538,7 @@ def texttemplatesrc(self):
"""
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
@@ -1558,7 +1558,7 @@ def texttemplatesrc(self, val):
def tsrc(self):
"""
Sets the source reference on Chart Studio Cloud for t .
-
+
The 'tsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1579,7 +1579,7 @@ def uid(self):
"""
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
@@ -1614,7 +1614,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1637,9 +1637,9 @@ def unselected(self):
- 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
@@ -1667,7 +1667,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1688,7 +1688,7 @@ def visible(self, val):
def width(self):
"""
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
@@ -1709,7 +1709,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -1729,7 +1729,7 @@ def widthsrc(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1751,7 +1751,7 @@ def x0(self):
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
@@ -1773,7 +1773,7 @@ def xaxis(self):
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
@@ -1795,7 +1795,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1886,7 +1886,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1906,7 +1906,7 @@ def xsrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1928,7 +1928,7 @@ def y0(self):
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
@@ -1950,7 +1950,7 @@ def yaxis(self):
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
@@ -1972,7 +1972,7 @@ def yaxis(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -2063,7 +2063,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -2491,7 +2491,7 @@ def __init__(
):
"""
Construct a new Bar object
-
+
The data visualized by the span of the bars is set in `y` if
`orientation` is set th "v" (the default) and the labels are
set in `x`. By setting `orientation` to "h", the roles are
diff --git a/packages/python/plotly/plotly/graph_objs/_barpolar.py b/packages/python/plotly/plotly/graph_objs/_barpolar.py
index 004639ced07..24b4b62a16f 100644
--- a/packages/python/plotly/plotly/graph_objs/_barpolar.py
+++ b/packages/python/plotly/plotly/graph_objs/_barpolar.py
@@ -63,7 +63,7 @@ def base(self):
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
@@ -82,7 +82,7 @@ def base(self, val):
def basesrc(self):
"""
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
@@ -105,7 +105,7 @@ def customdata(self):
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
@@ -126,7 +126,7 @@ def customdatasrc(self):
"""
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
@@ -146,7 +146,7 @@ def customdatasrc(self, val):
def dr(self):
"""
Sets the r coordinate step.
-
+
The 'dr' property is a number and may be specified as:
- An int or float
@@ -168,7 +168,7 @@ def dtheta(self):
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
@@ -190,7 +190,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -215,7 +215,7 @@ def hoverinfosrc(self):
"""
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
@@ -239,9 +239,9 @@ def hoverlabel(self):
- 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
@@ -312,7 +312,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -335,7 +335,7 @@ def hovertemplatesrc(self):
"""
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
@@ -355,7 +355,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -378,7 +378,7 @@ def hovertextsrc(self):
"""
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
@@ -400,7 +400,7 @@ def ids(self):
Assigns id labels to 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
@@ -420,7 +420,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -442,7 +442,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -467,9 +467,9 @@ def marker(self):
- 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
@@ -591,7 +591,7 @@ def meta(self):
access trace `meta` 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
@@ -610,7 +610,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -631,7 +631,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -653,7 +653,7 @@ def offset(self):
"""
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
@@ -674,7 +674,7 @@ def offset(self, val):
def offsetsrc(self):
"""
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
@@ -694,7 +694,7 @@ def offsetsrc(self, val):
def opacity(self):
"""
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]
@@ -714,7 +714,7 @@ def opacity(self, val):
def r(self):
"""
Sets the radial coordinates
-
+
The 'r' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -736,7 +736,7 @@ def r0(self):
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
@@ -755,7 +755,7 @@ def r0(self, val):
def rsrc(self):
"""
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
@@ -779,9 +779,9 @@ def selected(self):
- 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
@@ -812,7 +812,7 @@ def selectedpoints(self):
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
@@ -832,7 +832,7 @@ def showlegend(self):
"""
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)
@@ -856,9 +856,9 @@ def stream(self):
- 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
@@ -888,7 +888,7 @@ def subplot(self):
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
@@ -913,7 +913,7 @@ def text(self):
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
@@ -935,7 +935,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -955,7 +955,7 @@ def textsrc(self, val):
def theta(self):
"""
Sets the angular coordinates
-
+
The 'theta' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -977,7 +977,7 @@ def theta0(self):
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
@@ -996,7 +996,7 @@ def theta0(self, val):
def thetasrc(self):
"""
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
@@ -1017,7 +1017,7 @@ def thetaunit(self):
"""
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']
@@ -1039,7 +1039,7 @@ def uid(self):
"""
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
@@ -1074,7 +1074,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1097,9 +1097,9 @@ def unselected(self):
- 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
@@ -1127,7 +1127,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1148,7 +1148,7 @@ def visible(self, val):
def width(self):
"""
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
@@ -1169,7 +1169,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -1434,7 +1434,7 @@ def __init__(
):
"""
Construct a new Barpolar object
-
+
The data visualized by the radial span of the bars is set in
`r`
diff --git a/packages/python/plotly/plotly/graph_objs/_box.py b/packages/python/plotly/plotly/graph_objs/_box.py
index 0a0bb9073c8..bded57100f0 100644
--- a/packages/python/plotly/plotly/graph_objs/_box.py
+++ b/packages/python/plotly/plotly/graph_objs/_box.py
@@ -96,7 +96,7 @@ def alignmentgroup(self):
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
@@ -120,7 +120,7 @@ def boxmean(self):
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]
@@ -149,7 +149,7 @@ def boxpoints(self):
`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]
@@ -173,7 +173,7 @@ def customdata(self):
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
@@ -194,7 +194,7 @@ def customdatasrc(self):
"""
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
@@ -215,7 +215,7 @@ def dx(self):
"""
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
@@ -236,7 +236,7 @@ def dy(self):
"""
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
@@ -258,7 +258,7 @@ def fillcolor(self):
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)')
@@ -319,7 +319,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -344,7 +344,7 @@ def hoverinfosrc(self):
"""
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
@@ -368,9 +368,9 @@ def hoverlabel(self):
- 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
@@ -424,7 +424,7 @@ def hoveron(self):
"""
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
@@ -464,7 +464,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -487,7 +487,7 @@ def hovertemplatesrc(self):
"""
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
@@ -507,7 +507,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -530,7 +530,7 @@ def hovertextsrc(self):
"""
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
@@ -552,7 +552,7 @@ def ids(self):
Assigns id labels to 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
@@ -572,7 +572,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -595,7 +595,7 @@ def jitter(self):
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]
@@ -617,7 +617,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -642,9 +642,9 @@ def line(self):
- 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
@@ -671,7 +671,7 @@ def lowerfence(self):
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
@@ -692,7 +692,7 @@ def lowerfencesrc(self):
"""
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
@@ -716,9 +716,9 @@ def marker(self):
- 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:
-
+
color
Sets themarkercolor. It accepts either a
specific color or an array of numbers that are
@@ -762,7 +762,7 @@ def mean(self):
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
@@ -782,7 +782,7 @@ def mean(self, val):
def meansrc(self):
"""
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
@@ -803,7 +803,7 @@ def median(self):
"""
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
@@ -823,7 +823,7 @@ def median(self, val):
def mediansrc(self):
"""
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
@@ -852,7 +852,7 @@ def meta(self):
access trace `meta` 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
@@ -871,7 +871,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -894,7 +894,7 @@ def name(self):
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
@@ -923,7 +923,7 @@ def notched(self):
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)
@@ -948,7 +948,7 @@ def notchspan(self):
`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
@@ -969,7 +969,7 @@ def notchspansrc(self):
"""
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
@@ -990,7 +990,7 @@ def notchwidth(self):
"""
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]
@@ -1012,7 +1012,7 @@ def offsetgroup(self):
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
@@ -1033,7 +1033,7 @@ def offsetgroup(self, val):
def opacity(self):
"""
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]
@@ -1054,7 +1054,7 @@ def orientation(self):
"""
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']
@@ -1079,7 +1079,7 @@ def pointpos(self):
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]
@@ -1100,7 +1100,7 @@ def q1(self):
"""
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
@@ -1120,7 +1120,7 @@ def q1(self, val):
def q1src(self):
"""
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
@@ -1141,7 +1141,7 @@ def q3(self):
"""
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
@@ -1161,7 +1161,7 @@ def q3(self, val):
def q3src(self):
"""
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
@@ -1192,7 +1192,7 @@ def quartilemethod(self):
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']
@@ -1217,7 +1217,7 @@ def sd(self):
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
@@ -1237,7 +1237,7 @@ def sd(self, val):
def sdsrc(self):
"""
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
@@ -1261,9 +1261,9 @@ def selected(self):
- 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
@@ -1289,7 +1289,7 @@ def selectedpoints(self):
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
@@ -1309,7 +1309,7 @@ def showlegend(self):
"""
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)
@@ -1333,9 +1333,9 @@ def stream(self):
- 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
@@ -1366,7 +1366,7 @@ def text(self):
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
@@ -1388,7 +1388,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1409,7 +1409,7 @@ def uid(self):
"""
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
@@ -1444,7 +1444,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1467,9 +1467,9 @@ def unselected(self):
- 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
@@ -1495,7 +1495,7 @@ def upperfence(self):
under the q1/median/q3 signature. If `upperfence` is not
provided but a sample (in `y` or `x`) is set, we compute the
lower as the last sample point above 1.5 times the IQR.
-
+
The 'upperfence' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1516,7 +1516,7 @@ def upperfencesrc(self):
"""
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
@@ -1538,7 +1538,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1560,7 +1560,7 @@ def whiskerwidth(self):
"""
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]
@@ -1582,7 +1582,7 @@ def width(self):
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]
@@ -1603,7 +1603,7 @@ def x(self):
"""
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
@@ -1625,7 +1625,7 @@ def x0(self):
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
@@ -1647,7 +1647,7 @@ def xaxis(self):
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
@@ -1669,7 +1669,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1760,7 +1760,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1781,7 +1781,7 @@ def y(self):
"""
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
@@ -1803,7 +1803,7 @@ def y0(self):
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
@@ -1825,7 +1825,7 @@ def yaxis(self):
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
@@ -1847,7 +1847,7 @@ def yaxis(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1938,7 +1938,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -2419,7 +2419,7 @@ def __init__(
):
"""
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,
diff --git a/packages/python/plotly/plotly/graph_objs/_candlestick.py b/packages/python/plotly/plotly/graph_objs/_candlestick.py
index e0913708aa9..0a7ab25d579 100644
--- a/packages/python/plotly/plotly/graph_objs/_candlestick.py
+++ b/packages/python/plotly/plotly/graph_objs/_candlestick.py
@@ -60,7 +60,7 @@ class Candlestick(_BaseTraceType):
def close(self):
"""
Sets the close values.
-
+
The 'close' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -80,7 +80,7 @@ def close(self, val):
def closesrc(self):
"""
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
@@ -103,7 +103,7 @@ def customdata(self):
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
@@ -124,7 +124,7 @@ def customdatasrc(self):
"""
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
@@ -148,9 +148,9 @@ def decreasing(self):
- 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
@@ -177,7 +177,7 @@ def decreasing(self, val):
def high(self):
"""
Sets the high values.
-
+
The 'high' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -197,7 +197,7 @@ def high(self, val):
def highsrc(self):
"""
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
@@ -219,7 +219,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -244,7 +244,7 @@ def hoverinfosrc(self):
"""
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
@@ -268,9 +268,9 @@ def hoverlabel(self):
- 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
@@ -326,7 +326,7 @@ def hoverlabel(self, val):
def hovertext(self):
"""
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
@@ -349,7 +349,7 @@ def hovertextsrc(self):
"""
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
@@ -371,7 +371,7 @@ def ids(self):
Assigns id labels to 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
@@ -391,7 +391,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -415,9 +415,9 @@ def increasing(self):
- 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
@@ -446,7 +446,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -471,9 +471,9 @@ def line(self):
- 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
@@ -497,7 +497,7 @@ def line(self, val):
def low(self):
"""
Sets the low values.
-
+
The 'low' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -517,7 +517,7 @@ def low(self, val):
def lowsrc(self):
"""
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
@@ -546,7 +546,7 @@ def meta(self):
access trace `meta` 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
@@ -565,7 +565,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -586,7 +586,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -607,7 +607,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -627,7 +627,7 @@ def opacity(self, val):
def open(self):
"""
Sets the open values.
-
+
The 'open' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -647,7 +647,7 @@ def open(self, val):
def opensrc(self):
"""
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
@@ -672,7 +672,7 @@ def selectedpoints(self):
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
@@ -692,7 +692,7 @@ def showlegend(self):
"""
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)
@@ -716,9 +716,9 @@ def stream(self):
- 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
@@ -748,7 +748,7 @@ def text(self):
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
@@ -770,7 +770,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -791,7 +791,7 @@ def uid(self):
"""
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
@@ -826,7 +826,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -847,7 +847,7 @@ def visible(self):
Determines whether or not this 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']
@@ -869,7 +869,7 @@ def whiskerwidth(self):
"""
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]
@@ -890,7 +890,7 @@ def x(self):
"""
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
@@ -913,7 +913,7 @@ def xaxis(self):
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
@@ -935,7 +935,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1026,7 +1026,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1049,7 +1049,7 @@ def yaxis(self):
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
@@ -1298,7 +1298,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_carpet.py b/packages/python/plotly/plotly/graph_objs/_carpet.py
index 62a40687973..23a1daea88e 100644
--- a/packages/python/plotly/plotly/graph_objs/_carpet.py
+++ b/packages/python/plotly/plotly/graph_objs/_carpet.py
@@ -50,7 +50,7 @@ class Carpet(_BaseTraceType):
def a(self):
"""
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
@@ -72,7 +72,7 @@ def a0(self):
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
@@ -96,9 +96,9 @@ def aaxis(self):
- 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
@@ -131,7 +131,7 @@ def aaxis(self):
"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
@@ -234,7 +234,7 @@ def aaxis(self):
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,
@@ -273,7 +273,7 @@ def aaxis(self):
the default property values to use for elements
of carpet.aaxis.tickformatstops
tickmode
-
+
tickprefix
Sets a tick label prefix.
ticksuffix
@@ -330,7 +330,7 @@ def aaxis(self, val):
def asrc(self):
"""
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
@@ -350,7 +350,7 @@ def asrc(self, val):
def b(self):
"""
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
@@ -372,7 +372,7 @@ def b0(self):
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
@@ -396,9 +396,9 @@ def baxis(self):
- 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
@@ -431,7 +431,7 @@ def baxis(self):
"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
@@ -534,7 +534,7 @@ def baxis(self):
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,
@@ -573,7 +573,7 @@ def baxis(self):
the default property values to use for elements
of carpet.baxis.tickformatstops
tickmode
-
+
tickprefix
Sets a tick label prefix.
ticksuffix
@@ -630,7 +630,7 @@ def baxis(self, val):
def bsrc(self):
"""
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
@@ -652,7 +652,7 @@ def carpet(self):
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
@@ -674,7 +674,7 @@ def cheaterslope(self):
"""
The shift applied to each successive row of data in creating a
cheater plot. Only used if `x` is been ommitted.
-
+
The 'cheaterslope' property is a number and may be specified as:
- An int or float
@@ -697,7 +697,7 @@ def color(self):
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)')
@@ -759,7 +759,7 @@ def customdata(self):
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
@@ -780,7 +780,7 @@ def customdatasrc(self):
"""
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
@@ -800,7 +800,7 @@ def customdatasrc(self, val):
def da(self):
"""
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
@@ -820,7 +820,7 @@ def da(self, val):
def db(self):
"""
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
@@ -840,17 +840,17 @@ def db(self, val):
def font(self):
"""
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
@@ -888,7 +888,7 @@ def ids(self):
Assigns id labels to 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
@@ -908,7 +908,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -937,7 +937,7 @@ def meta(self):
access trace `meta` 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
@@ -956,7 +956,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -977,7 +977,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -998,7 +998,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -1022,9 +1022,9 @@ def stream(self):
- 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
@@ -1052,7 +1052,7 @@ def uid(self):
"""
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
@@ -1087,7 +1087,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1108,7 +1108,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1131,7 +1131,7 @@ def x(self):
A two dimensional array of x coordinates at each carpet point.
If ommitted, the plot is a cheater plot and the xaxis is hidden
by default.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1154,7 +1154,7 @@ def xaxis(self):
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
@@ -1176,7 +1176,7 @@ def xaxis(self, val):
def xsrc(self):
"""
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
@@ -1196,7 +1196,7 @@ def xsrc(self, val):
def y(self):
"""
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
@@ -1219,7 +1219,7 @@ def yaxis(self):
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
@@ -1241,7 +1241,7 @@ def yaxis(self, val):
def ysrc(self):
"""
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
@@ -1441,7 +1441,7 @@ def __init__(
):
"""
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`
diff --git a/packages/python/plotly/plotly/graph_objs/_choropleth.py b/packages/python/plotly/plotly/graph_objs/_choropleth.py
index b45b4376469..62c077cad42 100644
--- a/packages/python/plotly/plotly/graph_objs/_choropleth.py
+++ b/packages/python/plotly/plotly/graph_objs/_choropleth.py
@@ -67,7 +67,7 @@ def autocolorscale(self):
`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)
@@ -92,7 +92,7 @@ def coloraxis(self):
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
@@ -118,9 +118,9 @@ def colorbar(self):
- 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
@@ -361,14 +361,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -407,7 +407,7 @@ def customdata(self):
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
@@ -428,7 +428,7 @@ def customdatasrc(self):
"""
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
@@ -451,7 +451,7 @@ def featureidkey(self):
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
@@ -475,7 +475,7 @@ def geo(self):
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
@@ -501,7 +501,7 @@ def geojson(self):
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
@@ -522,7 +522,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -547,7 +547,7 @@ def hoverinfosrc(self):
"""
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
@@ -571,9 +571,9 @@ def hoverlabel(self):
- 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
@@ -644,7 +644,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -667,7 +667,7 @@ def hovertemplatesrc(self):
"""
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
@@ -687,7 +687,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -710,7 +710,7 @@ def hovertextsrc(self):
"""
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
@@ -732,7 +732,7 @@ def ids(self):
Assigns id labels to 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
@@ -752,7 +752,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -774,7 +774,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -799,7 +799,7 @@ def locationmode(self):
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']
@@ -821,7 +821,7 @@ def locations(self):
"""
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
@@ -842,7 +842,7 @@ def locationssrc(self):
"""
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
@@ -866,9 +866,9 @@ def marker(self):
- 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
@@ -904,7 +904,7 @@ def meta(self):
access trace `meta` 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
@@ -923,7 +923,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -944,7 +944,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def reversescale(self):
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)
@@ -991,9 +991,9 @@ def selected(self):
- 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
@@ -1020,7 +1020,7 @@ def selectedpoints(self):
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
@@ -1040,7 +1040,7 @@ def showlegend(self):
"""
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)
@@ -1061,7 +1061,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1085,9 +1085,9 @@ def stream(self):
- 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
@@ -1114,7 +1114,7 @@ def stream(self, val):
def text(self):
"""
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
@@ -1136,7 +1136,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1157,7 +1157,7 @@ def uid(self):
"""
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
@@ -1192,7 +1192,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1215,9 +1215,9 @@ def unselected(self):
- 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
@@ -1241,7 +1241,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1262,7 +1262,7 @@ def visible(self, val):
def z(self):
"""
Sets the color values.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1285,7 +1285,7 @@ def zauto(self):
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)
@@ -1306,7 +1306,7 @@ def zmax(self):
"""
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
@@ -1328,7 +1328,7 @@ def zmid(self):
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
@@ -1349,7 +1349,7 @@ def zmin(self):
"""
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
@@ -1369,7 +1369,7 @@ def zmin(self, val):
def zsrc(self):
"""
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
@@ -1670,7 +1670,7 @@ def __init__(
):
"""
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`.
diff --git a/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py b/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py
index ecf8f35a73a..5122acf09a8 100644
--- a/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py
+++ b/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py
@@ -67,7 +67,7 @@ def autocolorscale(self):
`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)
@@ -90,7 +90,7 @@ def below(self):
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
@@ -116,7 +116,7 @@ def coloraxis(self):
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
@@ -142,9 +142,9 @@ def colorbar(self):
- 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
@@ -386,14 +386,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -432,7 +432,7 @@ def customdata(self):
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
@@ -453,7 +453,7 @@ def customdatasrc(self):
"""
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
@@ -475,7 +475,7 @@ def featureidkey(self):
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
@@ -499,7 +499,7 @@ def geojson(self):
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
@@ -520,7 +520,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -545,7 +545,7 @@ def hoverinfosrc(self):
"""
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
@@ -569,9 +569,9 @@ def hoverlabel(self):
- 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
@@ -643,7 +643,7 @@ def hovertemplate(self):
in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -666,7 +666,7 @@ def hovertemplatesrc(self):
"""
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
@@ -686,7 +686,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -709,7 +709,7 @@ def hovertextsrc(self):
"""
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
@@ -731,7 +731,7 @@ def ids(self):
Assigns id labels to 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
@@ -751,7 +751,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -773,7 +773,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -795,7 +795,7 @@ def locations(self):
"""
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
@@ -816,7 +816,7 @@ def locationssrc(self):
"""
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
@@ -840,9 +840,9 @@ def marker(self):
- 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
@@ -878,7 +878,7 @@ def meta(self):
access trace `meta` 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
@@ -897,7 +897,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -918,7 +918,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -941,7 +941,7 @@ def reversescale(self):
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)
@@ -965,9 +965,9 @@ def selected(self):
- 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
@@ -994,7 +994,7 @@ def selectedpoints(self):
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
@@ -1014,7 +1014,7 @@ def showlegend(self):
"""
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)
@@ -1035,7 +1035,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1059,9 +1059,9 @@ def stream(self):
- 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
@@ -1091,7 +1091,7 @@ def subplot(self):
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
@@ -1113,7 +1113,7 @@ def subplot(self, val):
def text(self):
"""
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
@@ -1135,7 +1135,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1156,7 +1156,7 @@ def uid(self):
"""
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
@@ -1191,7 +1191,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1214,9 +1214,9 @@ def unselected(self):
- 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
@@ -1240,7 +1240,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1261,7 +1261,7 @@ def visible(self, val):
def z(self):
"""
Sets the color values.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1284,7 +1284,7 @@ def zauto(self):
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)
@@ -1305,7 +1305,7 @@ def zmax(self):
"""
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
@@ -1327,7 +1327,7 @@ def zmid(self):
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
@@ -1348,7 +1348,7 @@ def zmin(self):
"""
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
@@ -1368,7 +1368,7 @@ def zmin(self, val):
def zsrc(self):
"""
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
@@ -1666,7 +1666,7 @@ def __init__(
):
"""
Construct a new Choroplethmapbox 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`.
diff --git a/packages/python/plotly/plotly/graph_objs/_cone.py b/packages/python/plotly/plotly/graph_objs/_cone.py
index c3d73af166d..b7af2f82cc4 100644
--- a/packages/python/plotly/plotly/graph_objs/_cone.py
+++ b/packages/python/plotly/plotly/graph_objs/_cone.py
@@ -71,7 +71,7 @@ def anchor(self):
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']
@@ -97,7 +97,7 @@ def autocolorscale(self):
`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)
@@ -120,7 +120,7 @@ def cauto(self):
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)
@@ -142,7 +142,7 @@ def cmax(self):
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
@@ -165,7 +165,7 @@ def cmid(self):
`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
@@ -187,7 +187,7 @@ def cmin(self):
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
@@ -212,7 +212,7 @@ def coloraxis(self):
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
@@ -238,9 +238,9 @@ def colorbar(self):
- 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
@@ -478,14 +478,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -524,7 +524,7 @@ def customdata(self):
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
@@ -545,7 +545,7 @@ def customdatasrc(self):
"""
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
@@ -567,7 +567,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -592,7 +592,7 @@ def hoverinfosrc(self):
"""
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
@@ -616,9 +616,9 @@ def hoverlabel(self):
- 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
@@ -690,7 +690,7 @@ def hovertemplate(self):
secondary box, for example "{fullData.name}". To
hide the secondary box completely, use an empty tag
``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -713,7 +713,7 @@ def hovertemplatesrc(self):
"""
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
@@ -733,7 +733,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -756,7 +756,7 @@ def hovertextsrc(self):
"""
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
@@ -778,7 +778,7 @@ def ids(self):
Assigns id labels to 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
@@ -798,7 +798,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -820,7 +820,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -845,9 +845,9 @@ def lighting(self):
- 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.
@@ -893,9 +893,9 @@ def lightposition(self):
- 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.
@@ -931,7 +931,7 @@ def meta(self):
access trace `meta` 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
@@ -950,7 +950,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -971,7 +971,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -997,7 +997,7 @@ def opacity(self):
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]
@@ -1019,7 +1019,7 @@ def reversescale(self):
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)
@@ -1042,7 +1042,7 @@ def scene(self):
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
@@ -1065,7 +1065,7 @@ def showlegend(self):
"""
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)
@@ -1086,7 +1086,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1109,7 +1109,7 @@ def sizemode(self):
unitless) scalar (normalized by the max u/v/w norm in the
vector field) or as "absolute" value (in the same units as the
vector field).
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['scaled', 'absolute']
@@ -1139,7 +1139,7 @@ def sizeref(self):
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]
@@ -1163,9 +1163,9 @@ def stream(self):
- 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
@@ -1194,7 +1194,7 @@ def text(self):
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
@@ -1216,7 +1216,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1236,7 +1236,7 @@ def textsrc(self, val):
def u(self):
"""
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
@@ -1257,7 +1257,7 @@ def uid(self):
"""
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
@@ -1292,7 +1292,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1311,7 +1311,7 @@ def uirevision(self, val):
def usrc(self):
"""
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
@@ -1331,7 +1331,7 @@ def usrc(self, val):
def v(self):
"""
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
@@ -1353,7 +1353,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1374,7 +1374,7 @@ def visible(self, val):
def vsrc(self):
"""
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
@@ -1394,7 +1394,7 @@ def vsrc(self, val):
def w(self):
"""
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
@@ -1414,7 +1414,7 @@ def w(self, val):
def wsrc(self):
"""
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
@@ -1435,7 +1435,7 @@ def x(self):
"""
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
@@ -1455,7 +1455,7 @@ def x(self, val):
def xsrc(self):
"""
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
@@ -1476,7 +1476,7 @@ def y(self):
"""
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
@@ -1496,7 +1496,7 @@ def y(self, val):
def ysrc(self):
"""
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
@@ -1517,7 +1517,7 @@ def z(self):
"""
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
@@ -1537,7 +1537,7 @@ def z(self, val):
def zsrc(self):
"""
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
@@ -1871,7 +1871,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_contour.py b/packages/python/plotly/plotly/graph_objs/_contour.py
index 9db47b58d68..71e14a7ac21 100644
--- a/packages/python/plotly/plotly/graph_objs/_contour.py
+++ b/packages/python/plotly/plotly/graph_objs/_contour.py
@@ -87,7 +87,7 @@ def autocolorscale(self):
`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)
@@ -110,7 +110,7 @@ def autocontour(self):
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)
@@ -135,7 +135,7 @@ def coloraxis(self):
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
@@ -161,9 +161,9 @@ def colorbar(self):
- 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
@@ -404,14 +404,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -449,7 +449,7 @@ def connectgaps(self):
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)
@@ -473,9 +473,9 @@ def contours(self):
- 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
@@ -559,7 +559,7 @@ def customdata(self):
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
@@ -580,7 +580,7 @@ def customdatasrc(self):
"""
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
@@ -600,7 +600,7 @@ def customdatasrc(self, val):
def dx(self):
"""
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
@@ -620,7 +620,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -642,7 +642,7 @@ def fillcolor(self):
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)')
@@ -705,7 +705,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -730,7 +730,7 @@ def hoverinfosrc(self):
"""
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
@@ -754,9 +754,9 @@ def hoverlabel(self):
- 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
@@ -810,7 +810,7 @@ def hoverongaps(self):
"""
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)
@@ -848,7 +848,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -871,7 +871,7 @@ def hovertemplatesrc(self):
"""
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
@@ -891,7 +891,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
Same as `text`.
-
+
The 'hovertext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -912,7 +912,7 @@ def hovertextsrc(self):
"""
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
@@ -934,7 +934,7 @@ def ids(self):
Assigns id labels to 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
@@ -954,7 +954,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -976,7 +976,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1001,9 +1001,9 @@ def line(self):
- 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
@@ -1047,7 +1047,7 @@ def meta(self):
access trace `meta` 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
@@ -1066,7 +1066,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1087,7 +1087,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1111,7 +1111,7 @@ def ncontours(self):
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]
@@ -1132,7 +1132,7 @@ def ncontours(self, val):
def opacity(self):
"""
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]
@@ -1154,7 +1154,7 @@ def reversescale(self):
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)
@@ -1175,7 +1175,7 @@ def showlegend(self):
"""
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)
@@ -1196,7 +1196,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1220,9 +1220,9 @@ def stream(self):
- 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
@@ -1249,7 +1249,7 @@ def stream(self, val):
def text(self):
"""
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
@@ -1269,7 +1269,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1289,7 +1289,7 @@ def textsrc(self, val):
def transpose(self):
"""
Transposes the z data.
-
+
The 'transpose' property must be specified as a bool
(either True, or False)
@@ -1310,7 +1310,7 @@ def uid(self):
"""
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
@@ -1345,7 +1345,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1366,7 +1366,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1387,7 +1387,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1409,7 +1409,7 @@ def x0(self):
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
@@ -1431,7 +1431,7 @@ def xaxis(self):
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
@@ -1453,7 +1453,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1544,7 +1544,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1567,7 +1567,7 @@ def xtype(self):
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']
@@ -1588,7 +1588,7 @@ def xtype(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1610,7 +1610,7 @@ def y0(self):
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
@@ -1632,7 +1632,7 @@ def yaxis(self):
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
@@ -1654,7 +1654,7 @@ def yaxis(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1745,7 +1745,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -1768,7 +1768,7 @@ def ytype(self):
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']
@@ -1789,7 +1789,7 @@ def ytype(self, val):
def z(self):
"""
Sets the z data.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1812,7 +1812,7 @@ def zauto(self):
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)
@@ -1835,7 +1835,7 @@ def zhoverformat(self):
languages which are very similar to those in Python. See:
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'zhoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1857,7 +1857,7 @@ def zmax(self):
"""
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
@@ -1879,7 +1879,7 @@ def zmid(self):
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
@@ -1900,7 +1900,7 @@ def zmin(self):
"""
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
@@ -1920,7 +1920,7 @@ def zmin(self, val):
def zsrc(self):
"""
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
@@ -2314,7 +2314,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_contourcarpet.py b/packages/python/plotly/plotly/graph_objs/_contourcarpet.py
index af48b006769..fabd29e295f 100644
--- a/packages/python/plotly/plotly/graph_objs/_contourcarpet.py
+++ b/packages/python/plotly/plotly/graph_objs/_contourcarpet.py
@@ -67,7 +67,7 @@ class Contourcarpet(_BaseTraceType):
def a(self):
"""
Sets the x coordinates.
-
+
The 'a' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -89,7 +89,7 @@ def a0(self):
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
@@ -108,7 +108,7 @@ def a0(self, val):
def asrc(self):
"""
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
@@ -131,7 +131,7 @@ def atype(self):
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']
@@ -157,7 +157,7 @@ def autocolorscale(self):
`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)
@@ -180,7 +180,7 @@ def autocontour(self):
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)
@@ -200,7 +200,7 @@ def autocontour(self, val):
def b(self):
"""
Sets the y coordinates.
-
+
The 'b' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -222,7 +222,7 @@ def b0(self):
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
@@ -241,7 +241,7 @@ def b0(self, val):
def bsrc(self):
"""
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
@@ -264,7 +264,7 @@ def btype(self):
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']
@@ -286,7 +286,7 @@ def carpet(self):
"""
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
@@ -312,7 +312,7 @@ def coloraxis(self):
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
@@ -338,9 +338,9 @@ def colorbar(self):
- 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
@@ -582,14 +582,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -629,9 +629,9 @@ def contours(self):
- 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
@@ -713,7 +713,7 @@ def customdata(self):
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
@@ -734,7 +734,7 @@ def customdatasrc(self):
"""
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
@@ -754,7 +754,7 @@ def customdatasrc(self, val):
def da(self):
"""
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
@@ -774,7 +774,7 @@ def da(self, val):
def db(self):
"""
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
@@ -796,7 +796,7 @@ def fillcolor(self):
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)')
@@ -857,7 +857,7 @@ def fillcolor(self, val):
def hovertext(self):
"""
Same as `text`.
-
+
The 'hovertext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -878,7 +878,7 @@ def hovertextsrc(self):
"""
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
@@ -900,7 +900,7 @@ def ids(self):
Assigns id labels to 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
@@ -920,7 +920,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -942,7 +942,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,9 +967,9 @@ def line(self):
- 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
@@ -1013,7 +1013,7 @@ def meta(self):
access trace `meta` 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
@@ -1032,7 +1032,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1053,7 +1053,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1077,7 +1077,7 @@ def ncontours(self):
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]
@@ -1098,7 +1098,7 @@ def ncontours(self, val):
def opacity(self):
"""
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]
@@ -1120,7 +1120,7 @@ def reversescale(self):
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)
@@ -1141,7 +1141,7 @@ def showlegend(self):
"""
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)
@@ -1162,7 +1162,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1186,9 +1186,9 @@ def stream(self):
- 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
@@ -1215,7 +1215,7 @@ def stream(self, val):
def text(self):
"""
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
@@ -1235,7 +1235,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1255,7 +1255,7 @@ def textsrc(self, val):
def transpose(self):
"""
Transposes the z data.
-
+
The 'transpose' property must be specified as a bool
(either True, or False)
@@ -1276,7 +1276,7 @@ def uid(self):
"""
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
@@ -1311,7 +1311,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1332,7 +1332,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1356,7 +1356,7 @@ def xaxis(self):
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
@@ -1381,7 +1381,7 @@ def yaxis(self):
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
@@ -1403,7 +1403,7 @@ def yaxis(self, val):
def z(self):
"""
Sets the z data.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1426,7 +1426,7 @@ def zauto(self):
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)
@@ -1447,7 +1447,7 @@ def zmax(self):
"""
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
@@ -1469,7 +1469,7 @@ def zmid(self):
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
@@ -1490,7 +1490,7 @@ def zmin(self):
"""
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
@@ -1510,7 +1510,7 @@ def zmin(self, val):
def zsrc(self):
"""
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
@@ -1806,7 +1806,7 @@ def __init__(
):
"""
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.
diff --git a/packages/python/plotly/plotly/graph_objs/_densitymapbox.py b/packages/python/plotly/plotly/graph_objs/_densitymapbox.py
index 483f071f151..bc196ea59dc 100644
--- a/packages/python/plotly/plotly/graph_objs/_densitymapbox.py
+++ b/packages/python/plotly/plotly/graph_objs/_densitymapbox.py
@@ -66,7 +66,7 @@ def autocolorscale(self):
`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)
@@ -89,7 +89,7 @@ def below(self):
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
@@ -115,7 +115,7 @@ def coloraxis(self):
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
@@ -141,9 +141,9 @@ def colorbar(self):
- 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
@@ -385,14 +385,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -431,7 +431,7 @@ def customdata(self):
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
@@ -452,7 +452,7 @@ def customdatasrc(self):
"""
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
@@ -474,7 +474,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -499,7 +499,7 @@ def hoverinfosrc(self):
"""
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
@@ -523,9 +523,9 @@ def hoverlabel(self):
- 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
@@ -596,7 +596,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -619,7 +619,7 @@ def hovertemplatesrc(self):
"""
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
@@ -643,7 +643,7 @@ def hovertext(self):
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
@@ -666,7 +666,7 @@ def hovertextsrc(self):
"""
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
@@ -688,7 +688,7 @@ def ids(self):
Assigns id labels to 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
@@ -708,7 +708,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -728,7 +728,7 @@ def idssrc(self, val):
def lat(self):
"""
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
@@ -748,7 +748,7 @@ def lat(self, val):
def latsrc(self):
"""
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
@@ -770,7 +770,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -791,7 +791,7 @@ def legendgroup(self, val):
def lon(self):
"""
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
@@ -811,7 +811,7 @@ def lon(self, val):
def lonsrc(self):
"""
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
@@ -840,7 +840,7 @@ def meta(self):
access trace `meta` 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
@@ -859,7 +859,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -880,7 +880,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -901,7 +901,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -923,7 +923,7 @@ def radius(self):
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
@@ -944,7 +944,7 @@ def radius(self, val):
def radiussrc(self):
"""
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
@@ -966,7 +966,7 @@ def reversescale(self):
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)
@@ -987,7 +987,7 @@ def showlegend(self):
"""
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)
@@ -1008,7 +1008,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1032,9 +1032,9 @@ def stream(self):
- 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
@@ -1064,7 +1064,7 @@ def subplot(self):
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
@@ -1091,7 +1091,7 @@ def text(self):
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
@@ -1113,7 +1113,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1134,7 +1134,7 @@ def uid(self):
"""
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
@@ -1169,7 +1169,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1190,7 +1190,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1212,7 +1212,7 @@ def z(self):
"""
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
@@ -1235,7 +1235,7 @@ def zauto(self):
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)
@@ -1256,7 +1256,7 @@ def zmax(self):
"""
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
@@ -1278,7 +1278,7 @@ def zmid(self):
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
@@ -1299,7 +1299,7 @@ def zmin(self):
"""
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
@@ -1319,7 +1319,7 @@ def zmin(self, val):
def zsrc(self):
"""
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
@@ -1615,7 +1615,7 @@ def __init__(
):
"""
Construct a new Densitymapbox object
-
+
Draws a bivariate kernel density estimation with a Gaussian
kernel from `lon` and `lat` coordinates and optional `z` values
using a colorscale.
diff --git a/packages/python/plotly/plotly/graph_objs/_deprecations.py b/packages/python/plotly/plotly/graph_objs/_deprecations.py
index 6c415286931..d8caedcb79f 100644
--- a/packages/python/plotly/plotly/graph_objs/_deprecations.py
+++ b/packages/python/plotly/plotly/graph_objs/_deprecations.py
@@ -7,25 +7,25 @@
class Data(list):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -44,19 +44,19 @@ def __init__(self, *args, **kwargs):
class Annotations(list):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -72,17 +72,17 @@ def __init__(self, *args, **kwargs):
class Frames(list):
"""
- plotly.graph_objs.Frames is deprecated.
-Please replace it with a list or tuple of instances of the following types
- - plotly.graph_objs.Frame
+ plotly.graph_objs.Frames is deprecated.
+ Please replace it with a list or tuple of instances of the following types
+ - plotly.graph_objs.Frame
"""
def __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
+ plotly.graph_objs.Frames is deprecated.
+ Please replace it with a list or tuple of instances of the following types
+ - plotly.graph_objs.Frame
"""
warnings.warn(
@@ -97,19 +97,19 @@ def __init__(self, *args, **kwargs):
class AngularAxis(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -125,19 +125,19 @@ def __init__(self, *args, **kwargs):
class Annotation(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -153,21 +153,21 @@ def __init__(self, *args, **kwargs):
class ColorBar(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -184,21 +184,21 @@ def __init__(self, *args, **kwargs):
class Contours(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -215,21 +215,21 @@ def __init__(self, *args, **kwargs):
class ErrorX(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -246,21 +246,21 @@ def __init__(self, *args, **kwargs):
class ErrorY(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -277,17 +277,17 @@ def __init__(self, *args, **kwargs):
class ErrorZ(dict):
"""
- plotly.graph_objs.ErrorZ is deprecated.
-Please replace it with one of the following more specific types
- - plotly.graph_objs.scatter3d.ErrorZ
+ plotly.graph_objs.ErrorZ is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.scatter3d.ErrorZ
"""
def __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
+ plotly.graph_objs.ErrorZ is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.scatter3d.ErrorZ
"""
warnings.warn(
@@ -302,21 +302,21 @@ def __init__(self, *args, **kwargs):
class Font(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -333,17 +333,17 @@ def __init__(self, *args, **kwargs):
class Legend(dict):
"""
- plotly.graph_objs.Legend is deprecated.
-Please replace it with one of the following more specific types
- - plotly.graph_objs.layout.Legend
+ plotly.graph_objs.Legend is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.Legend
"""
def __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
+ plotly.graph_objs.Legend is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.Legend
"""
warnings.warn(
@@ -358,21 +358,21 @@ def __init__(self, *args, **kwargs):
class Line(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -389,17 +389,17 @@ def __init__(self, *args, **kwargs):
class Margin(dict):
"""
- plotly.graph_objs.Margin is deprecated.
-Please replace it with one of the following more specific types
- - plotly.graph_objs.layout.Margin
+ plotly.graph_objs.Margin is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.Margin
"""
def __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
+ plotly.graph_objs.Margin is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.Margin
"""
warnings.warn(
@@ -414,21 +414,21 @@ def __init__(self, *args, **kwargs):
class Marker(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -445,19 +445,19 @@ def __init__(self, *args, **kwargs):
class RadialAxis(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -473,17 +473,17 @@ def __init__(self, *args, **kwargs):
class Scene(dict):
"""
- plotly.graph_objs.Scene is deprecated.
-Please replace it with one of the following more specific types
- - plotly.graph_objs.layout.Scene
+ plotly.graph_objs.Scene is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.Scene
"""
def __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
+ plotly.graph_objs.Scene is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.Scene
"""
warnings.warn(
@@ -498,19 +498,19 @@ def __init__(self, *args, **kwargs):
class Stream(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -526,19 +526,19 @@ def __init__(self, *args, **kwargs):
class XAxis(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -554,19 +554,19 @@ def __init__(self, *args, **kwargs):
class YAxis(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -582,17 +582,17 @@ def __init__(self, *args, **kwargs):
class ZAxis(dict):
"""
- plotly.graph_objs.ZAxis is deprecated.
-Please replace it with one of the following more specific types
- - plotly.graph_objs.layout.scene.ZAxis
+ plotly.graph_objs.ZAxis is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.scene.ZAxis
"""
def __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
+ plotly.graph_objs.ZAxis is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.layout.scene.ZAxis
"""
warnings.warn(
@@ -607,19 +607,19 @@ def __init__(self, *args, **kwargs):
class XBins(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -635,19 +635,19 @@ def __init__(self, *args, **kwargs):
class YBins(dict):
"""
- 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
+ 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
"""
def __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
+ 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
"""
warnings.warn(
@@ -663,25 +663,25 @@ def __init__(self, *args, **kwargs):
class Trace(dict):
"""
- 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.
+ 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.
"""
def __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.
+ 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.
"""
warnings.warn(
@@ -700,17 +700,17 @@ def __init__(self, *args, **kwargs):
class Histogram2dcontour(dict):
"""
- plotly.graph_objs.Histogram2dcontour is deprecated.
-Please replace it with one of the following more specific types
- - plotly.graph_objs.Histogram2dContour
+ plotly.graph_objs.Histogram2dcontour is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.Histogram2dContour
"""
def __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
+ plotly.graph_objs.Histogram2dcontour is deprecated.
+ Please replace it with one of the following more specific types
+ - plotly.graph_objs.Histogram2dContour
"""
warnings.warn(
diff --git a/packages/python/plotly/plotly/graph_objs/_figure.py b/packages/python/plotly/plotly/graph_objs/_figure.py
index 05e48d370f0..81c5fcc4ea4 100644
--- a/packages/python/plotly/plotly/graph_objs/_figure.py
+++ b/packages/python/plotly/plotly/graph_objs/_figure.py
@@ -7,7 +7,7 @@ def __init__(
):
"""
Create a new :class:Figure instance
-
+
Parameters
----------
data
@@ -34,21 +34,21 @@ def __init__(
'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:
-
+
activeshape
:class:`plotly.graph_objects.layout.Activeshape
` instance or dict with compatible properties
@@ -540,16 +540,16 @@ def __init__(
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
@@ -573,7 +573,7 @@ def __init__(
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
@@ -617,7 +617,7 @@ def add_area(
):
"""
Add a new Area trace
-
+
Parameters
----------
customdata
@@ -843,7 +843,7 @@ def add_bar(
):
"""
Add a new Bar trace
-
+
The data visualized by the span of the bars is set in `y` if
`orientation` is set th "v" (the default) and the labels are
set in `x`. By setting `orientation` to "h", the roles are
@@ -1326,7 +1326,7 @@ def add_barpolar(
):
"""
Add a new Barpolar trace
-
+
The data visualized by the radial span of the bars is set in
`r`
@@ -1668,7 +1668,7 @@ def add_box(
):
"""
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,
@@ -2224,7 +2224,7 @@ def add_candlestick(
):
"""
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
@@ -2520,7 +2520,7 @@ def add_carpet(
):
"""
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`
@@ -2778,7 +2778,7 @@ def add_choropleth(
):
"""
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`.
@@ -3124,7 +3124,7 @@ def add_choroplethmapbox(
):
"""
Add a new Choroplethmapbox trace
-
+
GeoJSON features to be filled are set in `geojson` The data
that describes the choropleth value-to-color mapping is set in
`locations` and `z`.
@@ -3474,7 +3474,7 @@ def add_cone(
):
"""
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
@@ -3875,7 +3875,7 @@ def add_contour(
):
"""
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
@@ -4334,7 +4334,7 @@ def add_contourcarpet(
):
"""
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.
@@ -4684,7 +4684,7 @@ def add_densitymapbox(
):
"""
Add a new Densitymapbox trace
-
+
Draws a bivariate kernel density estimation with a Gaussian
kernel from `lon` and `lat` coordinates and optional `z` values
using a colorscale.
@@ -5041,7 +5041,7 @@ def add_funnel(
):
"""
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
@@ -5482,7 +5482,7 @@ def add_funnelarea(
):
"""
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
@@ -5824,7 +5824,7 @@ def add_heatmap(
):
"""
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`
@@ -6269,7 +6269,7 @@ def add_heatmapgl(
):
"""
Add a new Heatmapgl trace
-
+
WebGL version of the heatmap trace type.
Parameters
@@ -6595,7 +6595,7 @@ def add_histogram(
):
"""
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
@@ -6997,7 +6997,7 @@ def add_histogram2d(
):
"""
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
@@ -7438,7 +7438,7 @@ def add_histogram2dcontour(
):
"""
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
@@ -7868,7 +7868,7 @@ def add_image(
):
"""
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
@@ -8131,7 +8131,7 @@ def add_indicator(
):
"""
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
@@ -8331,7 +8331,7 @@ def add_isosurface(
):
"""
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-
@@ -8721,7 +8721,7 @@ def add_mesh3d(
):
"""
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-
@@ -9178,7 +9178,7 @@ def add_ohlc(
):
"""
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
@@ -9461,7 +9461,7 @@ def add_parcats(
):
"""
Add a new Parcats trace
-
+
Parallel categories diagram for multidimensional categorical
data.
@@ -9661,7 +9661,7 @@ def add_parcoords(
):
"""
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`.
@@ -9863,7 +9863,7 @@ def add_pie(
):
"""
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`
@@ -10224,7 +10224,7 @@ def add_pointcloud(
):
"""
Add a new Pointcloud trace
-
+
The data visualized as a point cloud set in `x` and `y` using
the WebGl plotting engine.
@@ -10478,7 +10478,7 @@ def add_sankey(
):
"""
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
@@ -10713,7 +10713,7 @@ def add_scatter(
):
"""
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
@@ -11230,7 +11230,7 @@ def add_scatter3d(
):
"""
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
@@ -11580,7 +11580,7 @@ def add_scattercarpet(
):
"""
Add a new Scattercarpet trace
-
+
Plots a scatter trace on either the first carpet axis or the
carpet axis with a matching `carpet` attribute.
@@ -11946,7 +11946,7 @@ def add_scattergeo(
):
"""
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
@@ -12326,7 +12326,7 @@ def add_scattergl(
):
"""
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
@@ -12752,7 +12752,7 @@ def add_scattermapbox(
):
"""
Add a new Scattermapbox trace
-
+
The data visualized as scatter point, lines or marker symbols
on a Mapbox GL geographic map is provided by longitude/latitude
pairs in `lon` and `lat`.
@@ -13091,7 +13091,7 @@ def add_scatterpolar(
):
"""
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`
@@ -13471,7 +13471,7 @@ def add_scatterpolargl(
):
"""
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
@@ -13848,7 +13848,7 @@ def add_scatterternary(
):
"""
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.
@@ -14216,7 +14216,7 @@ def add_splom(
):
"""
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`.
@@ -14511,7 +14511,7 @@ def add_streamtube(
):
"""
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
@@ -14874,7 +14874,7 @@ def add_sunburst(
):
"""
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".
@@ -15227,7 +15227,7 @@ def add_surface(
):
"""
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
@@ -15583,7 +15583,7 @@ def add_table(
):
"""
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-
@@ -15783,7 +15783,7 @@ def add_treemap(
):
"""
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
@@ -16132,7 +16132,7 @@ def add_violin(
):
"""
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
@@ -16554,7 +16554,7 @@ def add_volume(
):
"""
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-
@@ -16960,7 +16960,7 @@ def add_waterfall(
):
"""
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
@@ -17408,7 +17408,7 @@ def for_each_coloraxis(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all coloraxis objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17440,7 +17440,7 @@ def update_coloraxes(
"""
Perform a property update operation on all coloraxis objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17508,7 +17508,7 @@ def for_each_geo(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all geo objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17540,7 +17540,7 @@ def update_geos(
"""
Perform a property update operation on all geo objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17608,7 +17608,7 @@ def for_each_mapbox(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all mapbox objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17640,7 +17640,7 @@ def update_mapboxes(
"""
Perform a property update operation on all mapbox objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17708,7 +17708,7 @@ def for_each_polar(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all polar objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17740,7 +17740,7 @@ def update_polars(
"""
Perform a property update operation on all polar objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17808,7 +17808,7 @@ def for_each_scene(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all scene objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17840,7 +17840,7 @@ def update_scenes(
"""
Perform a property update operation on all scene objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17908,7 +17908,7 @@ def for_each_ternary(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all ternary objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17940,7 +17940,7 @@ def update_ternaries(
"""
Perform a property update operation on all ternary objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -18008,7 +18008,7 @@ def for_each_xaxis(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all xaxis objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -18040,7 +18040,7 @@ def update_xaxes(
"""
Perform a property update operation on all xaxis objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -18101,8 +18101,8 @@ def select_yaxes(self, selector=None, row=None, col=None, secondary_y=None):
* 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.
-
+ 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
@@ -18122,7 +18122,7 @@ def for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None
"""
Apply a function to all yaxis objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -18144,8 +18144,8 @@ def for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None
* 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.
-
+ 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
@@ -18175,7 +18175,7 @@ def update_yaxes(
"""
Perform a property update operation on all yaxis objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -18202,8 +18202,8 @@ def update_yaxes(
* 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.
-
+ 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
@@ -18427,7 +18427,7 @@ def add_annotation(
):
"""
Create and add a new annotation to the figure's layout
-
+
Parameters
----------
arg
@@ -18946,7 +18946,7 @@ def add_layout_image(
):
"""
Create and add a new image to the figure's layout
-
+
Parameters
----------
arg
@@ -19242,7 +19242,7 @@ def add_shape(
):
"""
Create and add a new shape to the figure's layout
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/_figurewidget.py b/packages/python/plotly/plotly/graph_objs/_figurewidget.py
index 6df993e9282..9a98a651dac 100644
--- a/packages/python/plotly/plotly/graph_objs/_figurewidget.py
+++ b/packages/python/plotly/plotly/graph_objs/_figurewidget.py
@@ -7,7 +7,7 @@ def __init__(
):
"""
Create a new :class:FigureWidget instance
-
+
Parameters
----------
data
@@ -34,21 +34,21 @@ def __init__(
'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:
-
+
activeshape
:class:`plotly.graph_objects.layout.Activeshape
` instance or dict with compatible properties
@@ -540,16 +540,16 @@ def __init__(
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
@@ -573,7 +573,7 @@ def __init__(
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
@@ -617,7 +617,7 @@ def add_area(
):
"""
Add a new Area trace
-
+
Parameters
----------
customdata
@@ -843,7 +843,7 @@ def add_bar(
):
"""
Add a new Bar trace
-
+
The data visualized by the span of the bars is set in `y` if
`orientation` is set th "v" (the default) and the labels are
set in `x`. By setting `orientation` to "h", the roles are
@@ -1326,7 +1326,7 @@ def add_barpolar(
):
"""
Add a new Barpolar trace
-
+
The data visualized by the radial span of the bars is set in
`r`
@@ -1668,7 +1668,7 @@ def add_box(
):
"""
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,
@@ -2224,7 +2224,7 @@ def add_candlestick(
):
"""
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
@@ -2520,7 +2520,7 @@ def add_carpet(
):
"""
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`
@@ -2778,7 +2778,7 @@ def add_choropleth(
):
"""
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`.
@@ -3124,7 +3124,7 @@ def add_choroplethmapbox(
):
"""
Add a new Choroplethmapbox trace
-
+
GeoJSON features to be filled are set in `geojson` The data
that describes the choropleth value-to-color mapping is set in
`locations` and `z`.
@@ -3474,7 +3474,7 @@ def add_cone(
):
"""
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
@@ -3875,7 +3875,7 @@ def add_contour(
):
"""
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
@@ -4334,7 +4334,7 @@ def add_contourcarpet(
):
"""
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.
@@ -4684,7 +4684,7 @@ def add_densitymapbox(
):
"""
Add a new Densitymapbox trace
-
+
Draws a bivariate kernel density estimation with a Gaussian
kernel from `lon` and `lat` coordinates and optional `z` values
using a colorscale.
@@ -5041,7 +5041,7 @@ def add_funnel(
):
"""
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
@@ -5482,7 +5482,7 @@ def add_funnelarea(
):
"""
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
@@ -5824,7 +5824,7 @@ def add_heatmap(
):
"""
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`
@@ -6269,7 +6269,7 @@ def add_heatmapgl(
):
"""
Add a new Heatmapgl trace
-
+
WebGL version of the heatmap trace type.
Parameters
@@ -6595,7 +6595,7 @@ def add_histogram(
):
"""
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
@@ -6997,7 +6997,7 @@ def add_histogram2d(
):
"""
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
@@ -7438,7 +7438,7 @@ def add_histogram2dcontour(
):
"""
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
@@ -7868,7 +7868,7 @@ def add_image(
):
"""
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
@@ -8131,7 +8131,7 @@ def add_indicator(
):
"""
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
@@ -8331,7 +8331,7 @@ def add_isosurface(
):
"""
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-
@@ -8721,7 +8721,7 @@ def add_mesh3d(
):
"""
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-
@@ -9178,7 +9178,7 @@ def add_ohlc(
):
"""
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
@@ -9461,7 +9461,7 @@ def add_parcats(
):
"""
Add a new Parcats trace
-
+
Parallel categories diagram for multidimensional categorical
data.
@@ -9661,7 +9661,7 @@ def add_parcoords(
):
"""
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`.
@@ -9863,7 +9863,7 @@ def add_pie(
):
"""
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`
@@ -10224,7 +10224,7 @@ def add_pointcloud(
):
"""
Add a new Pointcloud trace
-
+
The data visualized as a point cloud set in `x` and `y` using
the WebGl plotting engine.
@@ -10478,7 +10478,7 @@ def add_sankey(
):
"""
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
@@ -10713,7 +10713,7 @@ def add_scatter(
):
"""
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
@@ -11230,7 +11230,7 @@ def add_scatter3d(
):
"""
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
@@ -11580,7 +11580,7 @@ def add_scattercarpet(
):
"""
Add a new Scattercarpet trace
-
+
Plots a scatter trace on either the first carpet axis or the
carpet axis with a matching `carpet` attribute.
@@ -11946,7 +11946,7 @@ def add_scattergeo(
):
"""
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
@@ -12326,7 +12326,7 @@ def add_scattergl(
):
"""
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
@@ -12752,7 +12752,7 @@ def add_scattermapbox(
):
"""
Add a new Scattermapbox trace
-
+
The data visualized as scatter point, lines or marker symbols
on a Mapbox GL geographic map is provided by longitude/latitude
pairs in `lon` and `lat`.
@@ -13091,7 +13091,7 @@ def add_scatterpolar(
):
"""
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`
@@ -13471,7 +13471,7 @@ def add_scatterpolargl(
):
"""
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
@@ -13848,7 +13848,7 @@ def add_scatterternary(
):
"""
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.
@@ -14216,7 +14216,7 @@ def add_splom(
):
"""
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`.
@@ -14511,7 +14511,7 @@ def add_streamtube(
):
"""
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
@@ -14874,7 +14874,7 @@ def add_sunburst(
):
"""
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".
@@ -15227,7 +15227,7 @@ def add_surface(
):
"""
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
@@ -15583,7 +15583,7 @@ def add_table(
):
"""
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-
@@ -15783,7 +15783,7 @@ def add_treemap(
):
"""
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
@@ -16132,7 +16132,7 @@ def add_violin(
):
"""
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
@@ -16554,7 +16554,7 @@ def add_volume(
):
"""
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-
@@ -16960,7 +16960,7 @@ def add_waterfall(
):
"""
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
@@ -17408,7 +17408,7 @@ def for_each_coloraxis(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all coloraxis objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17440,7 +17440,7 @@ def update_coloraxes(
"""
Perform a property update operation on all coloraxis objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17508,7 +17508,7 @@ def for_each_geo(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all geo objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17540,7 +17540,7 @@ def update_geos(
"""
Perform a property update operation on all geo objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17608,7 +17608,7 @@ def for_each_mapbox(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all mapbox objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17640,7 +17640,7 @@ def update_mapboxes(
"""
Perform a property update operation on all mapbox objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17708,7 +17708,7 @@ def for_each_polar(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all polar objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17740,7 +17740,7 @@ def update_polars(
"""
Perform a property update operation on all polar objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17808,7 +17808,7 @@ def for_each_scene(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all scene objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17840,7 +17840,7 @@ def update_scenes(
"""
Perform a property update operation on all scene objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -17908,7 +17908,7 @@ def for_each_ternary(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all ternary objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -17940,7 +17940,7 @@ def update_ternaries(
"""
Perform a property update operation on all ternary objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -18008,7 +18008,7 @@ def for_each_xaxis(self, fn, selector=None, row=None, col=None):
"""
Apply a function to all xaxis objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -18040,7 +18040,7 @@ def update_xaxes(
"""
Perform a property update operation on all xaxis objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -18101,8 +18101,8 @@ def select_yaxes(self, selector=None, row=None, col=None, secondary_y=None):
* 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.
-
+ 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
@@ -18122,7 +18122,7 @@ def for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None
"""
Apply a function to all yaxis objects that satisfy the
specified selection criteria
-
+
Parameters
----------
fn:
@@ -18144,8 +18144,8 @@ def for_each_yaxis(self, fn, selector=None, row=None, col=None, secondary_y=None
* 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.
-
+ 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
@@ -18175,7 +18175,7 @@ def update_yaxes(
"""
Perform a property update operation on all yaxis objects
that satisfy the specified selection criteria
-
+
Parameters
----------
patch: dict
@@ -18202,8 +18202,8 @@ def update_yaxes(
* 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.
-
+ 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
@@ -18427,7 +18427,7 @@ def add_annotation(
):
"""
Create and add a new annotation to the figure's layout
-
+
Parameters
----------
arg
@@ -18946,7 +18946,7 @@ def add_layout_image(
):
"""
Create and add a new image to the figure's layout
-
+
Parameters
----------
arg
@@ -19242,7 +19242,7 @@ def add_shape(
):
"""
Create and add a new shape to the figure's layout
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/_frame.py b/packages/python/plotly/plotly/graph_objs/_frame.py
index c5a64e6d53e..d0ff061d6e1 100644
--- a/packages/python/plotly/plotly/graph_objs/_frame.py
+++ b/packages/python/plotly/plotly/graph_objs/_frame.py
@@ -19,7 +19,7 @@ def baseframe(self):
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
@@ -59,7 +59,7 @@ def group(self):
"""
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
@@ -98,7 +98,7 @@ def layout(self, val):
def name(self):
"""
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
@@ -120,7 +120,7 @@ def traces(self):
"""
A list of trace indices that identify the respective traces in
the data attribute
-
+
The 'traces' property accepts values of any type
Returns
@@ -173,7 +173,7 @@ def __init__(
):
"""
Construct a new Frame object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/_funnel.py b/packages/python/plotly/plotly/graph_objs/_funnel.py
index 6cb6abf76d7..fdafd431799 100644
--- a/packages/python/plotly/plotly/graph_objs/_funnel.py
+++ b/packages/python/plotly/plotly/graph_objs/_funnel.py
@@ -79,7 +79,7 @@ def alignmentgroup(self):
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
@@ -103,7 +103,7 @@ def cliponaxis(self):
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)
@@ -127,9 +127,9 @@ def connector(self):
- 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
@@ -157,7 +157,7 @@ def constraintext(self):
"""
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']
@@ -181,7 +181,7 @@ def customdata(self):
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
@@ -202,7 +202,7 @@ def customdatasrc(self):
"""
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
@@ -222,7 +222,7 @@ def customdatasrc(self, val):
def dx(self):
"""
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
@@ -242,7 +242,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -264,7 +264,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -289,7 +289,7 @@ def hoverinfosrc(self):
"""
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
@@ -313,9 +313,9 @@ def hoverlabel(self):
- 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
@@ -388,7 +388,7 @@ def hovertemplate(self):
secondary box, for example "{fullData.name}". To
hide the secondary box completely, use an empty tag
``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -411,7 +411,7 @@ def hovertemplatesrc(self):
"""
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
@@ -435,7 +435,7 @@ def hovertext(self):
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
@@ -458,7 +458,7 @@ def hovertextsrc(self):
"""
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
@@ -480,7 +480,7 @@ def ids(self):
Assigns id labels to 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
@@ -500,7 +500,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -521,7 +521,7 @@ def insidetextanchor(self):
"""
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']
@@ -542,17 +542,17 @@ def insidetextanchor(self, val):
def insidetextfont(self):
"""
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 .
@@ -577,7 +577,7 @@ def insidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -600,7 +600,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -625,9 +625,9 @@ def marker(self):
- 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
@@ -749,7 +749,7 @@ def meta(self):
access trace `meta` 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
@@ -768,7 +768,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -789,7 +789,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -812,7 +812,7 @@ def offset(self):
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
@@ -834,7 +834,7 @@ def offsetgroup(self):
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
@@ -855,7 +855,7 @@ def offsetgroup(self, val):
def opacity(self):
"""
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]
@@ -880,7 +880,7 @@ def orientation(self):
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']
@@ -901,17 +901,17 @@ def orientation(self, val):
def outsidetextfont(self):
"""
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 .
@@ -936,7 +936,7 @@ def outsidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -962,7 +962,7 @@ def selectedpoints(self):
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
@@ -982,7 +982,7 @@ def showlegend(self):
"""
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)
@@ -1006,9 +1006,9 @@ def stream(self):
- 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
@@ -1040,7 +1040,7 @@ def text(self):
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
@@ -1065,7 +1065,7 @@ def textangle(self):
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
@@ -1087,17 +1087,17 @@ def textangle(self, val):
def textfont(self):
"""
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 .
@@ -1122,7 +1122,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1145,7 +1145,7 @@ def textinfo(self):
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
@@ -1174,7 +1174,7 @@ def textposition(self):
then the text gets pushed inside. "auto" tries to position
`text` inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside.
-
+
The 'textposition' property is an enumeration that may be specified as:
- One of the following enumeration values:
['inside', 'outside', 'auto', 'none']
@@ -1197,7 +1197,7 @@ def textpositionsrc(self):
"""
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
@@ -1217,7 +1217,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1250,7 +1250,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1273,7 +1273,7 @@ def texttemplatesrc(self):
"""
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
@@ -1294,7 +1294,7 @@ def uid(self):
"""
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
@@ -1329,7 +1329,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1350,7 +1350,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1371,7 +1371,7 @@ def visible(self, val):
def width(self):
"""
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]
@@ -1391,7 +1391,7 @@ def width(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1413,7 +1413,7 @@ def x0(self):
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
@@ -1435,7 +1435,7 @@ def xaxis(self):
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
@@ -1524,7 +1524,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1544,7 +1544,7 @@ def xsrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1566,7 +1566,7 @@ def y0(self):
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
@@ -1588,7 +1588,7 @@ def yaxis(self):
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
@@ -1677,7 +1677,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -2062,7 +2062,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_funnelarea.py b/packages/python/plotly/plotly/graph_objs/_funnelarea.py
index 5517ec3edc5..d5677cd73c3 100644
--- a/packages/python/plotly/plotly/graph_objs/_funnelarea.py
+++ b/packages/python/plotly/plotly/graph_objs/_funnelarea.py
@@ -60,7 +60,7 @@ class Funnelarea(_BaseTraceType):
def aspectratio(self):
"""
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]
@@ -80,7 +80,7 @@ def aspectratio(self, val):
def baseratio(self):
"""
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]
@@ -103,7 +103,7 @@ def customdata(self):
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
@@ -124,7 +124,7 @@ def customdatasrc(self):
"""
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
@@ -144,7 +144,7 @@ def customdatasrc(self, val):
def dlabel(self):
"""
Sets the label step. See `label0` for more info.
-
+
The 'dlabel' property is a number and may be specified as:
- An int or float
@@ -168,9 +168,9 @@ def domain(self):
- 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
@@ -204,7 +204,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -229,7 +229,7 @@ def hoverinfosrc(self):
"""
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
@@ -253,9 +253,9 @@ def hoverlabel(self):
- 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
@@ -327,7 +327,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -350,7 +350,7 @@ def hovertemplatesrc(self):
"""
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
@@ -374,7 +374,7 @@ def hovertext(self):
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
@@ -397,7 +397,7 @@ def hovertextsrc(self):
"""
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
@@ -419,7 +419,7 @@ def ids(self):
Assigns id labels to 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
@@ -439,7 +439,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -459,17 +459,17 @@ def idssrc(self, val):
def insidetextfont(self):
"""
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 .
@@ -494,7 +494,7 @@ def insidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -517,7 +517,7 @@ def label0(self):
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
@@ -541,7 +541,7 @@ def labels(self):
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
@@ -561,7 +561,7 @@ def labels(self, val):
def labelssrc(self):
"""
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
@@ -583,7 +583,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -608,9 +608,9 @@ def marker(self):
- 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
@@ -648,7 +648,7 @@ def meta(self):
access trace `meta` 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
@@ -667,7 +667,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -688,7 +688,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -709,7 +709,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -731,7 +731,7 @@ def scalegroup(self):
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
@@ -753,7 +753,7 @@ def showlegend(self):
"""
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)
@@ -777,9 +777,9 @@ def stream(self):
- 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
@@ -810,7 +810,7 @@ def text(self):
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
@@ -830,17 +830,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -865,7 +865,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -886,7 +886,7 @@ def textfont(self, val):
def textinfo(self):
"""
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
@@ -909,7 +909,7 @@ def textinfo(self, val):
def textposition(self):
"""
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']
@@ -932,7 +932,7 @@ def textpositionsrc(self):
"""
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
@@ -952,7 +952,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -985,7 +985,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1008,7 +1008,7 @@ def texttemplatesrc(self):
"""
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
@@ -1032,9 +1032,9 @@ def title(self):
- 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
@@ -1067,7 +1067,7 @@ def uid(self):
"""
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
@@ -1102,7 +1102,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1122,7 +1122,7 @@ def values(self):
"""
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
@@ -1142,7 +1142,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -1164,7 +1164,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1441,7 +1441,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_heatmap.py b/packages/python/plotly/plotly/graph_objs/_heatmap.py
index 9a9840c3941..73b30d440c8 100644
--- a/packages/python/plotly/plotly/graph_objs/_heatmap.py
+++ b/packages/python/plotly/plotly/graph_objs/_heatmap.py
@@ -85,7 +85,7 @@ def autocolorscale(self):
`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)
@@ -110,7 +110,7 @@ def coloraxis(self):
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
@@ -136,9 +136,9 @@ def colorbar(self):
- 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
@@ -379,14 +379,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -425,7 +425,7 @@ def connectgaps(self):
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)
@@ -448,7 +448,7 @@ def customdata(self):
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
@@ -469,7 +469,7 @@ def customdatasrc(self):
"""
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
@@ -489,7 +489,7 @@ def customdatasrc(self, val):
def dx(self):
"""
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
@@ -509,7 +509,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -531,7 +531,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -556,7 +556,7 @@ def hoverinfosrc(self):
"""
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
@@ -580,9 +580,9 @@ def hoverlabel(self):
- 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
@@ -636,7 +636,7 @@ def hoverongaps(self):
"""
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)
@@ -674,7 +674,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -697,7 +697,7 @@ def hovertemplatesrc(self):
"""
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
@@ -717,7 +717,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
Same as `text`.
-
+
The 'hovertext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -738,7 +738,7 @@ def hovertextsrc(self):
"""
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
@@ -760,7 +760,7 @@ def ids(self):
Assigns id labels to 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
@@ -780,7 +780,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -802,7 +802,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -832,7 +832,7 @@ def meta(self):
access trace `meta` 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
@@ -851,7 +851,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -872,7 +872,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -893,7 +893,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -915,7 +915,7 @@ def reversescale(self):
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)
@@ -936,7 +936,7 @@ def showlegend(self):
"""
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)
@@ -957,7 +957,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -981,9 +981,9 @@ def stream(self):
- 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
@@ -1010,7 +1010,7 @@ def stream(self, val):
def text(self):
"""
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
@@ -1030,7 +1030,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1050,7 +1050,7 @@ def textsrc(self, val):
def transpose(self):
"""
Transposes the z data.
-
+
The 'transpose' property must be specified as a bool
(either True, or False)
@@ -1071,7 +1071,7 @@ def uid(self):
"""
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
@@ -1106,7 +1106,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1127,7 +1127,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1148,7 +1148,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1170,7 +1170,7 @@ def x0(self):
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
@@ -1192,7 +1192,7 @@ def xaxis(self):
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
@@ -1214,7 +1214,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1238,7 +1238,7 @@ def xcalendar(self, val):
def xgap(self):
"""
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]
@@ -1325,7 +1325,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1348,7 +1348,7 @@ def xtype(self):
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']
@@ -1369,7 +1369,7 @@ def xtype(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1391,7 +1391,7 @@ def y0(self):
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
@@ -1413,7 +1413,7 @@ def yaxis(self):
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
@@ -1435,7 +1435,7 @@ def yaxis(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1459,7 +1459,7 @@ def ycalendar(self, val):
def ygap(self):
"""
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]
@@ -1546,7 +1546,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -1569,7 +1569,7 @@ def ytype(self):
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']
@@ -1590,7 +1590,7 @@ def ytype(self, val):
def z(self):
"""
Sets the z data.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1613,7 +1613,7 @@ def zauto(self):
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)
@@ -1636,7 +1636,7 @@ def zhoverformat(self):
languages which are very similar to those in Python. See:
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'zhoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1658,7 +1658,7 @@ def zmax(self):
"""
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
@@ -1680,7 +1680,7 @@ def zmid(self):
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
@@ -1701,7 +1701,7 @@ def zmin(self):
"""
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
@@ -1721,7 +1721,7 @@ def zmin(self, val):
def zsmooth(self):
"""
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]
@@ -1742,7 +1742,7 @@ def zsmooth(self, val):
def zsrc(self):
"""
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
@@ -2118,7 +2118,7 @@ def __init__(
):
"""
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`
diff --git a/packages/python/plotly/plotly/graph_objs/_heatmapgl.py b/packages/python/plotly/plotly/graph_objs/_heatmapgl.py
index b0fe686c565..17f13c34ae4 100644
--- a/packages/python/plotly/plotly/graph_objs/_heatmapgl.py
+++ b/packages/python/plotly/plotly/graph_objs/_heatmapgl.py
@@ -66,7 +66,7 @@ def autocolorscale(self):
`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)
@@ -91,7 +91,7 @@ def coloraxis(self):
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
@@ -117,9 +117,9 @@ def colorbar(self):
- 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
@@ -360,14 +360,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -406,7 +406,7 @@ def customdata(self):
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
@@ -427,7 +427,7 @@ def customdatasrc(self):
"""
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
@@ -447,7 +447,7 @@ def customdatasrc(self, val):
def dx(self):
"""
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
@@ -467,7 +467,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -489,7 +489,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -514,7 +514,7 @@ def hoverinfosrc(self):
"""
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
@@ -538,9 +538,9 @@ def hoverlabel(self):
- 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
@@ -595,7 +595,7 @@ def ids(self):
Assigns id labels to 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
@@ -615,7 +615,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -644,7 +644,7 @@ def meta(self):
access trace `meta` 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
@@ -663,7 +663,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -684,7 +684,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -705,7 +705,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -727,7 +727,7 @@ def reversescale(self):
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)
@@ -748,7 +748,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -772,9 +772,9 @@ def stream(self):
- 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
@@ -801,7 +801,7 @@ def stream(self, val):
def text(self):
"""
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
@@ -821,7 +821,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -841,7 +841,7 @@ def textsrc(self, val):
def transpose(self):
"""
Transposes the z data.
-
+
The 'transpose' property must be specified as a bool
(either True, or False)
@@ -862,7 +862,7 @@ def uid(self):
"""
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
@@ -897,7 +897,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -918,7 +918,7 @@ def visible(self):
Determines whether or not this 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']
@@ -939,7 +939,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -961,7 +961,7 @@ def x0(self):
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
@@ -983,7 +983,7 @@ def xaxis(self):
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
@@ -1005,7 +1005,7 @@ def xaxis(self, val):
def xsrc(self):
"""
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
@@ -1028,7 +1028,7 @@ def xtype(self):
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']
@@ -1049,7 +1049,7 @@ def xtype(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1071,7 +1071,7 @@ def y0(self):
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
@@ -1093,7 +1093,7 @@ def yaxis(self):
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
@@ -1115,7 +1115,7 @@ def yaxis(self, val):
def ysrc(self):
"""
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
@@ -1138,7 +1138,7 @@ def ytype(self):
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']
@@ -1159,7 +1159,7 @@ def ytype(self, val):
def z(self):
"""
Sets the z data.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1182,7 +1182,7 @@ def zauto(self):
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)
@@ -1203,7 +1203,7 @@ def zmax(self):
"""
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
@@ -1225,7 +1225,7 @@ def zmid(self):
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
@@ -1246,7 +1246,7 @@ def zmin(self):
"""
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
@@ -1266,7 +1266,7 @@ def zmin(self, val):
def zsmooth(self):
"""
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]
@@ -1287,7 +1287,7 @@ def zsmooth(self, val):
def zsrc(self):
"""
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
@@ -1553,7 +1553,7 @@ def __init__(
):
"""
Construct a new Heatmapgl object
-
+
WebGL version of the heatmap trace type.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/_histogram.py b/packages/python/plotly/plotly/graph_objs/_histogram.py
index 477bea6018d..99836e616b9 100644
--- a/packages/python/plotly/plotly/graph_objs/_histogram.py
+++ b/packages/python/plotly/plotly/graph_objs/_histogram.py
@@ -70,7 +70,7 @@ def alignmentgroup(self):
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
@@ -94,7 +94,7 @@ def autobinx(self):
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)
@@ -117,7 +117,7 @@ def autobiny(self):
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)
@@ -143,7 +143,7 @@ def bingroup(self):
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
@@ -168,9 +168,9 @@ def cumulative(self):
- 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,
@@ -217,7 +217,7 @@ def customdata(self):
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
@@ -238,7 +238,7 @@ def customdatasrc(self):
"""
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
@@ -262,9 +262,9 @@ def error_x(self):
- 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
@@ -283,7 +283,7 @@ def error_x(self):
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
@@ -292,9 +292,9 @@ def error_x(self):
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
@@ -343,9 +343,9 @@ def error_y(self):
- 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
@@ -371,9 +371,9 @@ def error_y(self):
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
@@ -423,7 +423,7 @@ def histfunc(self):
"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']
@@ -456,7 +456,7 @@ def histnorm(self):
*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
@@ -480,7 +480,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -505,7 +505,7 @@ def hoverinfosrc(self):
"""
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
@@ -529,9 +529,9 @@ def hoverlabel(self):
- 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
@@ -603,7 +603,7 @@ def hovertemplate(self):
the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -626,7 +626,7 @@ def hovertemplatesrc(self):
"""
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
@@ -646,7 +646,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -669,7 +669,7 @@ def hovertextsrc(self):
"""
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
@@ -691,7 +691,7 @@ def ids(self):
Assigns id labels to 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
@@ -711,7 +711,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -733,7 +733,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -758,9 +758,9 @@ def marker(self):
- 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
@@ -883,7 +883,7 @@ def meta(self):
access trace `meta` 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
@@ -902,7 +902,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -923,7 +923,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -947,7 +947,7 @@ def nbinsx(self):
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]
@@ -971,7 +971,7 @@ def nbinsy(self):
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]
@@ -994,7 +994,7 @@ def offsetgroup(self):
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
@@ -1015,7 +1015,7 @@ def offsetgroup(self, val):
def opacity(self):
"""
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]
@@ -1036,7 +1036,7 @@ def orientation(self):
"""
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']
@@ -1061,9 +1061,9 @@ def selected(self):
- 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
@@ -1094,7 +1094,7 @@ def selectedpoints(self):
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
@@ -1114,7 +1114,7 @@ def showlegend(self):
"""
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)
@@ -1138,9 +1138,9 @@ def stream(self):
- 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
@@ -1170,7 +1170,7 @@ def text(self):
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
@@ -1192,7 +1192,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1213,7 +1213,7 @@ def uid(self):
"""
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
@@ -1248,7 +1248,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1271,9 +1271,9 @@ def unselected(self):
- 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
@@ -1301,7 +1301,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1322,7 +1322,7 @@ def visible(self, val):
def x(self):
"""
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
@@ -1345,7 +1345,7 @@ def xaxis(self):
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
@@ -1371,9 +1371,9 @@ def xbins(self):
- 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
@@ -1435,7 +1435,7 @@ def xbins(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1459,7 +1459,7 @@ def xcalendar(self, val):
def xsrc(self):
"""
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
@@ -1479,7 +1479,7 @@ def xsrc(self, val):
def y(self):
"""
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
@@ -1502,7 +1502,7 @@ def yaxis(self):
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
@@ -1528,9 +1528,9 @@ def ybins(self):
- 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
@@ -1592,7 +1592,7 @@ def ybins(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1616,7 +1616,7 @@ def ycalendar(self, val):
def ysrc(self):
"""
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
@@ -1949,7 +1949,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_histogram2d.py b/packages/python/plotly/plotly/graph_objs/_histogram2d.py
index 1c998deedc6..7bf3a019f3c 100644
--- a/packages/python/plotly/plotly/graph_objs/_histogram2d.py
+++ b/packages/python/plotly/plotly/graph_objs/_histogram2d.py
@@ -76,7 +76,7 @@ def autobinx(self):
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)
@@ -99,7 +99,7 @@ def autobiny(self):
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)
@@ -124,7 +124,7 @@ def autocolorscale(self):
`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)
@@ -146,7 +146,7 @@ def bingroup(self):
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
@@ -172,7 +172,7 @@ def coloraxis(self):
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
@@ -198,9 +198,9 @@ def colorbar(self):
- 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
@@ -442,14 +442,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -488,7 +488,7 @@ def customdata(self):
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
@@ -509,7 +509,7 @@ def customdatasrc(self):
"""
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
@@ -534,7 +534,7 @@ def histfunc(self):
"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']
@@ -567,7 +567,7 @@ def histnorm(self):
*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
@@ -591,7 +591,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -616,7 +616,7 @@ def hoverinfosrc(self):
"""
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
@@ -640,9 +640,9 @@ def hoverlabel(self):
- 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
@@ -714,7 +714,7 @@ def hovertemplate(self):
secondary box, for example "{fullData.name}". To
hide the secondary box completely, use an empty tag
``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -737,7 +737,7 @@ def hovertemplatesrc(self):
"""
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
@@ -759,7 +759,7 @@ def ids(self):
Assigns id labels to 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
@@ -779,7 +779,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -801,7 +801,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -826,9 +826,9 @@ def marker(self):
- 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
@@ -860,7 +860,7 @@ def meta(self):
access trace `meta` 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
@@ -879,7 +879,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -900,7 +900,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -924,7 +924,7 @@ def nbinsx(self):
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]
@@ -948,7 +948,7 @@ def nbinsy(self):
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]
@@ -969,7 +969,7 @@ def nbinsy(self, val):
def opacity(self):
"""
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]
@@ -991,7 +991,7 @@ def reversescale(self):
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)
@@ -1012,7 +1012,7 @@ def showlegend(self):
"""
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)
@@ -1033,7 +1033,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1057,9 +1057,9 @@ def stream(self):
- 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
@@ -1087,7 +1087,7 @@ def uid(self):
"""
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
@@ -1122,7 +1122,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1143,7 +1143,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1164,7 +1164,7 @@ def visible(self, val):
def x(self):
"""
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
@@ -1187,7 +1187,7 @@ def xaxis(self):
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
@@ -1213,7 +1213,7 @@ def xbingroup(self):
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
@@ -1238,9 +1238,9 @@ def xbins(self):
- 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
@@ -1292,7 +1292,7 @@ def xbins(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1316,7 +1316,7 @@ def xcalendar(self, val):
def xgap(self):
"""
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]
@@ -1336,7 +1336,7 @@ def xgap(self, val):
def xsrc(self):
"""
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
@@ -1356,7 +1356,7 @@ def xsrc(self, val):
def y(self):
"""
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
@@ -1379,7 +1379,7 @@ def yaxis(self):
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
@@ -1405,7 +1405,7 @@ def ybingroup(self):
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
@@ -1430,9 +1430,9 @@ def ybins(self):
- 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
@@ -1484,7 +1484,7 @@ def ybins(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1508,7 +1508,7 @@ def ycalendar(self, val):
def ygap(self):
"""
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]
@@ -1528,7 +1528,7 @@ def ygap(self, val):
def ysrc(self):
"""
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
@@ -1548,7 +1548,7 @@ def ysrc(self, val):
def z(self):
"""
Sets the aggregation data.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1571,7 +1571,7 @@ def zauto(self):
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)
@@ -1594,7 +1594,7 @@ def zhoverformat(self):
languages which are very similar to those in Python. See:
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'zhoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1616,7 +1616,7 @@ def zmax(self):
"""
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
@@ -1638,7 +1638,7 @@ def zmid(self):
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
@@ -1659,7 +1659,7 @@ def zmin(self):
"""
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
@@ -1679,7 +1679,7 @@ def zmin(self, val):
def zsmooth(self):
"""
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]
@@ -1700,7 +1700,7 @@ def zsmooth(self, val):
def zsrc(self):
"""
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
@@ -2070,7 +2070,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_histogram2dcontour.py b/packages/python/plotly/plotly/graph_objs/_histogram2dcontour.py
index e92cec6205c..ea36bf20aab 100644
--- a/packages/python/plotly/plotly/graph_objs/_histogram2dcontour.py
+++ b/packages/python/plotly/plotly/graph_objs/_histogram2dcontour.py
@@ -77,7 +77,7 @@ def autobinx(self):
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)
@@ -100,7 +100,7 @@ def autobiny(self):
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)
@@ -125,7 +125,7 @@ def autocolorscale(self):
`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)
@@ -148,7 +148,7 @@ def autocontour(self):
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)
@@ -170,7 +170,7 @@ def bingroup(self):
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
@@ -196,7 +196,7 @@ def coloraxis(self):
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
@@ -222,9 +222,9 @@ def colorbar(self):
- 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
@@ -466,14 +466,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -513,9 +513,9 @@ def contours(self):
- 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
@@ -599,7 +599,7 @@ def customdata(self):
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
@@ -620,7 +620,7 @@ def customdatasrc(self):
"""
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
@@ -645,7 +645,7 @@ def histfunc(self):
"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']
@@ -678,7 +678,7 @@ def histnorm(self):
*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
@@ -702,7 +702,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -727,7 +727,7 @@ def hoverinfosrc(self):
"""
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
@@ -751,9 +751,9 @@ def hoverlabel(self):
- 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
@@ -825,7 +825,7 @@ def hovertemplate(self):
secondary box, for example "{fullData.name}". To
hide the secondary box completely, use an empty tag
``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -848,7 +848,7 @@ def hovertemplatesrc(self):
"""
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
@@ -870,7 +870,7 @@ def ids(self):
Assigns id labels to 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
@@ -890,7 +890,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -912,7 +912,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -937,9 +937,9 @@ def line(self):
- 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
@@ -975,9 +975,9 @@ def marker(self):
- 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
@@ -1009,7 +1009,7 @@ def meta(self):
access trace `meta` 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
@@ -1028,7 +1028,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1049,7 +1049,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1073,7 +1073,7 @@ def nbinsx(self):
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]
@@ -1097,7 +1097,7 @@ def nbinsy(self):
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]
@@ -1121,7 +1121,7 @@ def ncontours(self):
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]
@@ -1142,7 +1142,7 @@ def ncontours(self, val):
def opacity(self):
"""
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]
@@ -1164,7 +1164,7 @@ def reversescale(self):
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)
@@ -1185,7 +1185,7 @@ def showlegend(self):
"""
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)
@@ -1206,7 +1206,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1230,9 +1230,9 @@ def stream(self):
- 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
@@ -1260,7 +1260,7 @@ def uid(self):
"""
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
@@ -1295,7 +1295,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1316,7 +1316,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1337,7 +1337,7 @@ def visible(self, val):
def x(self):
"""
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
@@ -1360,7 +1360,7 @@ def xaxis(self):
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
@@ -1386,7 +1386,7 @@ def xbingroup(self):
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
@@ -1411,9 +1411,9 @@ def xbins(self):
- 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
@@ -1465,7 +1465,7 @@ def xbins(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1489,7 +1489,7 @@ def xcalendar(self, val):
def xsrc(self):
"""
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
@@ -1509,7 +1509,7 @@ def xsrc(self, val):
def y(self):
"""
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
@@ -1532,7 +1532,7 @@ def yaxis(self):
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
@@ -1558,7 +1558,7 @@ def ybingroup(self):
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
@@ -1583,9 +1583,9 @@ def ybins(self):
- 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
@@ -1637,7 +1637,7 @@ def ybins(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1661,7 +1661,7 @@ def ycalendar(self, val):
def ysrc(self):
"""
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
@@ -1681,7 +1681,7 @@ def ysrc(self, val):
def z(self):
"""
Sets the aggregation data.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1704,7 +1704,7 @@ def zauto(self):
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)
@@ -1727,7 +1727,7 @@ def zhoverformat(self):
languages which are very similar to those in Python. See:
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'zhoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1749,7 +1749,7 @@ def zmax(self):
"""
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
@@ -1771,7 +1771,7 @@ def zmid(self):
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
@@ -1792,7 +1792,7 @@ def zmin(self):
"""
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
@@ -1812,7 +1812,7 @@ def zmin(self, val):
def zsrc(self):
"""
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
@@ -2194,7 +2194,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_image.py b/packages/python/plotly/plotly/graph_objs/_image.py
index 602115a6a8e..3e69441f3ad 100644
--- a/packages/python/plotly/plotly/graph_objs/_image.py
+++ b/packages/python/plotly/plotly/graph_objs/_image.py
@@ -54,7 +54,7 @@ def colormodel(self):
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']
@@ -78,7 +78,7 @@ def customdata(self):
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
@@ -99,7 +99,7 @@ def customdatasrc(self):
"""
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
@@ -119,7 +119,7 @@ def customdatasrc(self, val):
def dx(self):
"""
Set the pixel's horizontal size.
-
+
The 'dx' property is a number and may be specified as:
- An int or float
@@ -139,7 +139,7 @@ def dx(self, val):
def dy(self):
"""
Set the pixel's vertical size
-
+
The 'dy' property is a number and may be specified as:
- An int or float
@@ -161,7 +161,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -186,7 +186,7 @@ def hoverinfosrc(self):
"""
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
@@ -210,9 +210,9 @@ def hoverlabel(self):
- 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
@@ -284,7 +284,7 @@ def hovertemplate(self):
`` is displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -307,7 +307,7 @@ def hovertemplatesrc(self):
"""
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
@@ -327,7 +327,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
Same as `text`.
-
+
The 'hovertext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -348,7 +348,7 @@ def hovertextsrc(self):
"""
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
@@ -370,7 +370,7 @@ def ids(self):
Assigns id labels to 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
@@ -390,7 +390,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -419,7 +419,7 @@ def meta(self):
access trace `meta` 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
@@ -438,7 +438,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -459,7 +459,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -480,7 +480,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -501,7 +501,7 @@ def source(self):
"""
Specifies the data URI of the image to be visualized. The URI
consists of "data:image/[][;base64],"
-
+
The 'source' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -526,9 +526,9 @@ def stream(self):
- 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
@@ -555,7 +555,7 @@ def stream(self, val):
def text(self):
"""
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
@@ -575,7 +575,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -596,7 +596,7 @@ def uid(self):
"""
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
@@ -631,7 +631,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -652,7 +652,7 @@ def visible(self):
Determines whether or not this 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']
@@ -673,7 +673,7 @@ def visible(self, val):
def x0(self):
"""
Set the image's x position.
-
+
The 'x0' property accepts values of any type
Returns
@@ -695,7 +695,7 @@ def xaxis(self):
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
@@ -717,7 +717,7 @@ def xaxis(self, val):
def y0(self):
"""
Set the image's y position.
-
+
The 'y0' property accepts values of any type
Returns
@@ -739,7 +739,7 @@ def yaxis(self):
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
@@ -762,7 +762,7 @@ def z(self):
"""
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
@@ -781,29 +781,29 @@ def z(self, val):
@property
def zmax(self):
"""
- 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
+ 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
"""
return self["zmax"]
@@ -816,28 +816,28 @@ def zmax(self, val):
@property
def zmin(self):
"""
- 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
+ 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
"""
return self["zmin"]
@@ -851,7 +851,7 @@ def zmin(self, val):
def zsrc(self):
"""
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
@@ -1081,7 +1081,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_indicator.py b/packages/python/plotly/plotly/graph_objs/_indicator.py
index 47158210ce2..e8f000d7265 100644
--- a/packages/python/plotly/plotly/graph_objs/_indicator.py
+++ b/packages/python/plotly/plotly/graph_objs/_indicator.py
@@ -39,7 +39,7 @@ def align(self):
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']
@@ -63,7 +63,7 @@ def customdata(self):
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
@@ -84,7 +84,7 @@ def customdatasrc(self):
"""
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
@@ -108,9 +108,9 @@ def delta(self):
- 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
@@ -156,9 +156,9 @@ def domain(self):
- 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
@@ -189,15 +189,15 @@ def domain(self, val):
def gauge(self):
"""
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
@@ -245,7 +245,7 @@ def ids(self):
Assigns id labels to 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
@@ -265,7 +265,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -294,7 +294,7 @@ def meta(self):
access trace `meta` 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
@@ -313,7 +313,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -336,7 +336,7 @@ def mode(self):
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
@@ -359,7 +359,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -384,9 +384,9 @@ def number(self):
- 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
@@ -420,9 +420,9 @@ def stream(self):
- 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
@@ -453,9 +453,9 @@ def title(self):
- 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
@@ -482,7 +482,7 @@ def uid(self):
"""
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
@@ -517,7 +517,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -536,7 +536,7 @@ def uirevision(self, val):
def value(self):
"""
Sets the number to be displayed.
-
+
The 'value' property is a number and may be specified as:
- An int or float
@@ -558,7 +558,7 @@ def visible(self):
Determines whether or not this 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']
@@ -703,7 +703,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_isosurface.py b/packages/python/plotly/plotly/graph_objs/_isosurface.py
index cea1e3781dd..e78a466c21e 100644
--- a/packages/python/plotly/plotly/graph_objs/_isosurface.py
+++ b/packages/python/plotly/plotly/graph_objs/_isosurface.py
@@ -75,7 +75,7 @@ def autocolorscale(self):
`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)
@@ -99,9 +99,9 @@ def caps(self):
- 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
@@ -131,7 +131,7 @@ def cauto(self):
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)
@@ -152,7 +152,7 @@ def cmax(self):
"""
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
@@ -174,7 +174,7 @@ def cmid(self):
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
@@ -195,7 +195,7 @@ def cmin(self):
"""
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
@@ -220,7 +220,7 @@ def coloraxis(self):
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
@@ -246,9 +246,9 @@ def colorbar(self):
- 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
@@ -489,14 +489,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -536,9 +536,9 @@ def contour(self):
- 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
@@ -566,7 +566,7 @@ def customdata(self):
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
@@ -587,7 +587,7 @@ def customdatasrc(self):
"""
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
@@ -609,7 +609,7 @@ def flatshading(self):
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)
@@ -631,7 +631,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -656,7 +656,7 @@ def hoverinfosrc(self):
"""
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
@@ -680,9 +680,9 @@ def hoverlabel(self):
- 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
@@ -753,7 +753,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -776,7 +776,7 @@ def hovertemplatesrc(self):
"""
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
@@ -796,7 +796,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -819,7 +819,7 @@ def hovertextsrc(self):
"""
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
@@ -841,7 +841,7 @@ def ids(self):
Assigns id labels to 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
@@ -861,7 +861,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -881,7 +881,7 @@ def idssrc(self, val):
def isomax(self):
"""
Sets the maximum boundary for iso-surface plot.
-
+
The 'isomax' property is a number and may be specified as:
- An int or float
@@ -901,7 +901,7 @@ def isomax(self, val):
def isomin(self):
"""
Sets the minimum boundary for iso-surface plot.
-
+
The 'isomin' property is a number and may be specified as:
- An int or float
@@ -923,7 +923,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -948,9 +948,9 @@ def lighting(self):
- 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.
@@ -996,9 +996,9 @@ def lightposition(self):
- 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.
@@ -1034,7 +1034,7 @@ def meta(self):
access trace `meta` 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
@@ -1053,7 +1053,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1074,7 +1074,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1100,7 +1100,7 @@ def opacity(self):
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]
@@ -1122,7 +1122,7 @@ def reversescale(self):
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)
@@ -1145,7 +1145,7 @@ def scene(self):
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
@@ -1168,7 +1168,7 @@ def showlegend(self):
"""
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)
@@ -1189,7 +1189,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1213,9 +1213,9 @@ def slices(self):
- 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
@@ -1246,9 +1246,9 @@ def spaceframe(self):
- 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
@@ -1283,9 +1283,9 @@ def stream(self):
- 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
@@ -1316,9 +1316,9 @@ def surface(self):
- 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
@@ -1364,7 +1364,7 @@ def text(self):
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
@@ -1386,7 +1386,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1407,7 +1407,7 @@ def uid(self):
"""
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
@@ -1442,7 +1442,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1461,7 +1461,7 @@ def uirevision(self, val):
def value(self):
"""
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
@@ -1481,7 +1481,7 @@ def value(self, val):
def valuesrc(self):
"""
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
@@ -1503,7 +1503,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1524,7 +1524,7 @@ def visible(self, val):
def x(self):
"""
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
@@ -1544,7 +1544,7 @@ def x(self, val):
def xsrc(self):
"""
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
@@ -1564,7 +1564,7 @@ def xsrc(self, val):
def y(self):
"""
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
@@ -1584,7 +1584,7 @@ def y(self, val):
def ysrc(self):
"""
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
@@ -1604,7 +1604,7 @@ def ysrc(self, val):
def z(self):
"""
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
@@ -1624,7 +1624,7 @@ def z(self, val):
def zsrc(self):
"""
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
@@ -1947,7 +1947,7 @@ def __init__(
):
"""
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-
diff --git a/packages/python/plotly/plotly/graph_objs/_layout.py b/packages/python/plotly/plotly/graph_objs/_layout.py
index 195f2ef670d..d16b854b09a 100644
--- a/packages/python/plotly/plotly/graph_objs/_layout.py
+++ b/packages/python/plotly/plotly/graph_objs/_layout.py
@@ -155,9 +155,9 @@ def activeshape(self):
- 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.
@@ -184,9 +184,9 @@ def angularaxis(self):
- An instance of :class:`plotly.graph_objs.layout.AngularAxis`
- A dict of string/value properties that will be passed
to the AngularAxis constructor
-
+
Supported dict properties:
-
+
domain
Polar chart subplots are not supported yet.
This key has currently no effect.
@@ -249,9 +249,9 @@ def annotations(self):
- 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`
@@ -589,13 +589,13 @@ def annotationdefaults(self):
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
@@ -618,7 +618,7 @@ def autosize(self):
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)
@@ -639,7 +639,7 @@ def bargap(self):
"""
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]
@@ -660,7 +660,7 @@ def bargroupgap(self):
"""
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]
@@ -687,7 +687,7 @@ def barmode(self):
another centered around the shared location. With "overlay",
the bars are plotted over one another, you might need to an
"opacity" to see multiple bars.
-
+
The 'barmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['stack', 'group', 'overlay', 'relative']
@@ -711,7 +711,7 @@ def barnorm(self):
"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']
@@ -734,7 +734,7 @@ def boxgap(self):
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]
@@ -756,7 +756,7 @@ def boxgroupgap(self):
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]
@@ -781,7 +781,7 @@ def boxmode(self):
"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']
@@ -803,7 +803,7 @@ def calendar(self):
"""
Sets the default calendar system to use for interpreting and
displaying dates throughout the plot.
-
+
The 'calendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -839,7 +839,7 @@ def clickmode(self):
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
@@ -866,9 +866,9 @@ def coloraxis(self):
- 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
@@ -947,9 +947,9 @@ def colorscale(self):
- 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
@@ -979,7 +979,7 @@ def colorscale(self, val):
def colorway(self):
"""
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
@@ -1027,7 +1027,7 @@ def datarevision(self):
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
@@ -1048,7 +1048,7 @@ def direction(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the direction corresponding to positive angles
in legacy polar charts.
-
+
The 'direction' property is an enumeration that may be specified as:
- One of the following enumeration values:
['clockwise', 'counterclockwise']
@@ -1071,7 +1071,7 @@ def dragmode(self):
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',
@@ -1096,7 +1096,7 @@ def editrevision(self):
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
@@ -1122,7 +1122,7 @@ def extendfunnelareacolors(self):
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)
@@ -1148,7 +1148,7 @@ def extendpiecolors(self):
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)
@@ -1175,7 +1175,7 @@ def extendsunburstcolors(self):
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)
@@ -1202,7 +1202,7 @@ def extendtreemapcolors(self):
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)
@@ -1223,17 +1223,17 @@ def font(self):
"""
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
@@ -1272,7 +1272,7 @@ def funnelareacolorway(self):
`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
@@ -1294,7 +1294,7 @@ def funnelgap(self):
"""
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]
@@ -1315,7 +1315,7 @@ def funnelgroupgap(self):
"""
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]
@@ -1340,7 +1340,7 @@ def funnelmode(self):
one another centered around the shared location. With
"overlay", the bars are plotted over one another, you might
need to an "opacity" to see multiple bars.
-
+
The 'funnelmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['stack', 'group', 'overlay']
@@ -1365,9 +1365,9 @@ def geo(self):
- 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
@@ -1487,9 +1487,9 @@ def grid(self):
- 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
@@ -1586,7 +1586,7 @@ def grid(self, val):
def height(self):
"""
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]
@@ -1608,7 +1608,7 @@ def hiddenlabels(self):
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
@@ -1629,7 +1629,7 @@ def hiddenlabelssrc(self):
"""
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
@@ -1653,7 +1653,7 @@ def hidesources(self):
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)
@@ -1679,7 +1679,7 @@ def hoverdistance(self):
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]
@@ -1704,9 +1704,9 @@ def hoverlabel(self):
- 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
@@ -1764,7 +1764,7 @@ def hovermode(self):
(depending on the trace's `orientation` value) for plots based
on cartesian coordinates. For anything else the default value
is "closest".
-
+
The 'hovermode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['x', 'y', 'closest', False, 'x unified', 'y unified']
@@ -1789,9 +1789,9 @@ def images(self):
- 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
@@ -1908,13 +1908,13 @@ def imagedefaults(self):
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
@@ -1937,9 +1937,9 @@ def legend(self):
- 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`.
@@ -2046,9 +2046,9 @@ def mapbox(self):
- 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
@@ -2136,9 +2136,9 @@ def margin(self):
- 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
@@ -2179,7 +2179,7 @@ def meta(self):
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
@@ -2198,7 +2198,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -2222,9 +2222,9 @@ def modebar(self):
- 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.
@@ -2261,9 +2261,9 @@ def newshape(self):
- 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
@@ -2310,7 +2310,7 @@ def orientation(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Rotates the entire polar by the given angle in legacy
polar charts.
-
+
The 'orientation' property is a angle (in degrees) that may be
specified as a number between -180 and 180. Numeric values outside this
range are converted to the equivalent value
@@ -2333,7 +2333,7 @@ def paper_bgcolor(self):
"""
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)')
@@ -2395,7 +2395,7 @@ def piecolorway(self):
`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
@@ -2417,7 +2417,7 @@ def plot_bgcolor(self):
"""
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)')
@@ -2480,9 +2480,9 @@ def polar(self):
- 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
@@ -2552,9 +2552,9 @@ def radialaxis(self):
- An instance of :class:`plotly.graph_objs.layout.RadialAxis`
- A dict of string/value properties that will be passed
to the RadialAxis constructor
-
+
Supported dict properties:
-
+
domain
Polar chart subplots are not supported yet.
This key has currently no effect.
@@ -2622,9 +2622,9 @@ def scene(self):
- 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
@@ -2650,7 +2650,7 @@ def scene(self):
aspectratio
Sets this scene's axis aspectratio.
bgcolor
-
+
camera
:class:`plotly.graph_objects.layout.scene.Camer
a` instance or dict with compatible properties
@@ -2696,7 +2696,7 @@ def selectdirection(self):
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']
@@ -2718,7 +2718,7 @@ def selectionrevision(self):
"""
Controls persistence of user-driven changes in selected points
from all traces.
-
+
The 'selectionrevision' property accepts values of any type
Returns
@@ -2740,7 +2740,7 @@ def separators(self):
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
@@ -2765,9 +2765,9 @@ def shapes(self):
- 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
@@ -2961,13 +2961,13 @@ def shapedefaults(self):
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
@@ -2990,7 +2990,7 @@ def showlegend(self):
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)
@@ -3014,9 +3014,9 @@ def sliders(self):
- 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.
@@ -3130,13 +3130,13 @@ def sliderdefaults(self):
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
@@ -3159,7 +3159,7 @@ def spikedistance(self):
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]
@@ -3183,7 +3183,7 @@ def sunburstcolorway(self):
`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
@@ -3222,32 +3222,32 @@ def template(self):
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
+ template is computed by merging together the collection of registered
templates
Returns
@@ -3270,9 +3270,9 @@ def ternary(self):
- 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
@@ -3317,9 +3317,9 @@ def title(self):
- 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:
-
+
font
Sets the title font. Note that the title's font
used to be customized by the now deprecated
@@ -3391,17 +3391,17 @@ def titlefont(self):
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
@@ -3423,7 +3423,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -3437,15 +3437,15 @@ def titlefont(self, val):
def transition(self):
"""
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
@@ -3476,7 +3476,7 @@ def treemapcolorway(self):
`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
@@ -3512,7 +3512,7 @@ def uirevision(self):
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
@@ -3535,9 +3535,9 @@ def uniformtext(self):
- 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.
@@ -3573,9 +3573,9 @@ def updatemenus(self):
- 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.
@@ -3674,13 +3674,13 @@ def updatemenudefaults(self):
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
@@ -3701,7 +3701,7 @@ def violingap(self):
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]
@@ -3723,7 +3723,7 @@ def violingroupgap(self):
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]
@@ -3748,7 +3748,7 @@ def violinmode(self):
"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']
@@ -3770,7 +3770,7 @@ def waterfallgap(self):
"""
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]
@@ -3791,7 +3791,7 @@ def waterfallgroupgap(self):
"""
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]
@@ -3815,7 +3815,7 @@ def waterfallmode(self):
to one another centered around the shared location. With
"overlay", the bars are plotted over one another, you might
need to an "opacity" to see multiple bars.
-
+
The 'waterfallmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['group', 'overlay']
@@ -3836,7 +3836,7 @@ def waterfallmode(self, val):
def width(self):
"""
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]
@@ -3860,9 +3860,9 @@ def xaxis(self):
- 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
@@ -4322,9 +4322,9 @@ def yaxis(self):
- 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
@@ -5309,7 +5309,7 @@ def __init__(
):
"""
Construct a new Layout object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/_mesh3d.py b/packages/python/plotly/plotly/graph_objs/_mesh3d.py
index 8079e8b85b8..bae3c6550ad 100644
--- a/packages/python/plotly/plotly/graph_objs/_mesh3d.py
+++ b/packages/python/plotly/plotly/graph_objs/_mesh3d.py
@@ -96,7 +96,7 @@ def alphahull(self):
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
@@ -121,7 +121,7 @@ def autocolorscale(self):
`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)
@@ -144,7 +144,7 @@ def cauto(self):
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)
@@ -166,7 +166,7 @@ def cmax(self):
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
@@ -189,7 +189,7 @@ def cmid(self):
`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
@@ -211,7 +211,7 @@ def cmin(self):
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
@@ -231,7 +231,7 @@ def cmin(self, val):
def color(self):
"""
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)')
@@ -297,7 +297,7 @@ def coloraxis(self):
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
@@ -323,9 +323,9 @@ def colorbar(self):
- 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
@@ -566,14 +566,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -613,9 +613,9 @@ def contour(self):
- 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
@@ -643,7 +643,7 @@ def customdata(self):
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
@@ -664,7 +664,7 @@ def customdatasrc(self):
"""
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
@@ -687,7 +687,7 @@ def delaunayaxis(self):
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']
@@ -709,7 +709,7 @@ def facecolor(self):
"""
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
@@ -730,7 +730,7 @@ def facecolorsrc(self):
"""
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
@@ -752,7 +752,7 @@ def flatshading(self):
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)
@@ -774,7 +774,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -799,7 +799,7 @@ def hoverinfosrc(self):
"""
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
@@ -823,9 +823,9 @@ def hoverlabel(self):
- 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
@@ -896,7 +896,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -919,7 +919,7 @@ def hovertemplatesrc(self):
"""
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
@@ -939,7 +939,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -962,7 +962,7 @@ def hovertextsrc(self):
"""
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
@@ -988,7 +988,7 @@ def i(self):
= 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
@@ -1010,7 +1010,7 @@ def ids(self):
Assigns id labels to 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
@@ -1030,7 +1030,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -1051,7 +1051,7 @@ def intensity(self):
"""
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
@@ -1071,7 +1071,7 @@ def intensity(self, val):
def intensitymode(self):
"""
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']
@@ -1093,7 +1093,7 @@ def intensitysrc(self):
"""
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
@@ -1113,7 +1113,7 @@ def intensitysrc(self, val):
def isrc(self):
"""
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
@@ -1139,7 +1139,7 @@ def j(self):
= 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
@@ -1159,7 +1159,7 @@ def j(self, val):
def jsrc(self):
"""
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
@@ -1185,7 +1185,7 @@ def k(self):
= 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
@@ -1205,7 +1205,7 @@ def k(self, val):
def ksrc(self):
"""
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
@@ -1227,7 +1227,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1252,9 +1252,9 @@ def lighting(self):
- 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.
@@ -1300,9 +1300,9 @@ def lightposition(self):
- 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.
@@ -1338,7 +1338,7 @@ def meta(self):
access trace `meta` 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
@@ -1357,7 +1357,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1378,7 +1378,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1404,7 +1404,7 @@ def opacity(self):
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]
@@ -1426,7 +1426,7 @@ def reversescale(self):
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)
@@ -1449,7 +1449,7 @@ def scene(self):
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
@@ -1472,7 +1472,7 @@ def showlegend(self):
"""
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)
@@ -1493,7 +1493,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1517,9 +1517,9 @@ def stream(self):
- 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
@@ -1548,7 +1548,7 @@ def text(self):
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
@@ -1570,7 +1570,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1591,7 +1591,7 @@ def uid(self):
"""
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
@@ -1626,7 +1626,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1648,7 +1648,7 @@ def vertexcolor(self):
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
@@ -1669,7 +1669,7 @@ def vertexcolorsrc(self):
"""
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
@@ -1691,7 +1691,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1714,7 +1714,7 @@ def x(self):
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
@@ -1734,7 +1734,7 @@ def x(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1758,7 +1758,7 @@ def xcalendar(self, val):
def xsrc(self):
"""
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
@@ -1780,7 +1780,7 @@ def y(self):
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
@@ -1800,7 +1800,7 @@ def y(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1824,7 +1824,7 @@ def ycalendar(self, val):
def ysrc(self):
"""
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
@@ -1846,7 +1846,7 @@ def z(self):
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
@@ -1866,7 +1866,7 @@ def z(self, val):
def zcalendar(self):
"""
Sets the calendar system to use with `z` date data.
-
+
The 'zcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1890,7 +1890,7 @@ def zcalendar(self, val):
def zsrc(self):
"""
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
@@ -2302,7 +2302,7 @@ def __init__(
):
"""
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-
diff --git a/packages/python/plotly/plotly/graph_objs/_ohlc.py b/packages/python/plotly/plotly/graph_objs/_ohlc.py
index d687b3ea616..0b059653bc8 100644
--- a/packages/python/plotly/plotly/graph_objs/_ohlc.py
+++ b/packages/python/plotly/plotly/graph_objs/_ohlc.py
@@ -60,7 +60,7 @@ class Ohlc(_BaseTraceType):
def close(self):
"""
Sets the close values.
-
+
The 'close' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -80,7 +80,7 @@ def close(self, val):
def closesrc(self):
"""
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
@@ -103,7 +103,7 @@ def customdata(self):
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
@@ -124,7 +124,7 @@ def customdatasrc(self):
"""
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
@@ -148,9 +148,9 @@ def decreasing(self):
- 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
@@ -171,7 +171,7 @@ def decreasing(self, val):
def high(self):
"""
Sets the high values.
-
+
The 'high' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -191,7 +191,7 @@ def high(self, val):
def highsrc(self):
"""
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
@@ -213,7 +213,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -238,7 +238,7 @@ def hoverinfosrc(self):
"""
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
@@ -262,9 +262,9 @@ def hoverlabel(self):
- 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
@@ -320,7 +320,7 @@ def hoverlabel(self, val):
def hovertext(self):
"""
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
@@ -343,7 +343,7 @@ def hovertextsrc(self):
"""
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
@@ -365,7 +365,7 @@ def ids(self):
Assigns id labels to 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
@@ -385,7 +385,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -409,9 +409,9 @@ def increasing(self):
- 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
@@ -434,7 +434,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -459,9 +459,9 @@ def line(self):
- 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",
@@ -492,7 +492,7 @@ def line(self, val):
def low(self):
"""
Sets the low values.
-
+
The 'low' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -512,7 +512,7 @@ def low(self, val):
def lowsrc(self):
"""
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
@@ -541,7 +541,7 @@ def meta(self):
access trace `meta` 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
@@ -560,7 +560,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -581,7 +581,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -602,7 +602,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -622,7 +622,7 @@ def opacity(self, val):
def open(self):
"""
Sets the open values.
-
+
The 'open' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -642,7 +642,7 @@ def open(self, val):
def opensrc(self):
"""
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
@@ -667,7 +667,7 @@ def selectedpoints(self):
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
@@ -687,7 +687,7 @@ def showlegend(self):
"""
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)
@@ -711,9 +711,9 @@ def stream(self):
- 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
@@ -743,7 +743,7 @@ def text(self):
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
@@ -765,7 +765,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -786,7 +786,7 @@ def tickwidth(self):
"""
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]
@@ -807,7 +807,7 @@ def uid(self):
"""
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
@@ -842,7 +842,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -863,7 +863,7 @@ def visible(self):
Determines whether or not this 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']
@@ -885,7 +885,7 @@ def x(self):
"""
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
@@ -908,7 +908,7 @@ def xaxis(self):
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
@@ -930,7 +930,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1021,7 +1021,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1044,7 +1044,7 @@ def yaxis(self):
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
@@ -1292,7 +1292,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_parcats.py b/packages/python/plotly/plotly/graph_objs/_parcats.py
index 9532dec058b..d68b940838c 100644
--- a/packages/python/plotly/plotly/graph_objs/_parcats.py
+++ b/packages/python/plotly/plotly/graph_objs/_parcats.py
@@ -43,7 +43,7 @@ def arrangement(self):
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']
@@ -65,7 +65,7 @@ def bundlecolors(self):
"""
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)
@@ -86,7 +86,7 @@ def counts(self):
"""
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
@@ -107,7 +107,7 @@ def counts(self, val):
def countssrc(self):
"""
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
@@ -127,15 +127,15 @@ def countssrc(self, val):
def dimensions(self):
"""
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
@@ -206,13 +206,13 @@ def dimensiondefaults(self):
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
@@ -235,9 +235,9 @@ def domain(self):
- 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
@@ -270,7 +270,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -297,7 +297,7 @@ def hoveron(self):
`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']
@@ -338,7 +338,7 @@ def hovertemplate(self):
`` is displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -359,17 +359,17 @@ def hovertemplate(self, val):
def labelfont(self):
"""
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
@@ -409,9 +409,9 @@ def line(self):
- 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
@@ -557,7 +557,7 @@ def meta(self):
access trace `meta` 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
@@ -576,7 +576,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -597,7 +597,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -620,7 +620,7 @@ def sortpaths(self):
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']
@@ -645,9 +645,9 @@ def stream(self):
- 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
@@ -674,17 +674,17 @@ def stream(self, val):
def tickfont(self):
"""
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
@@ -721,7 +721,7 @@ def uid(self):
"""
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
@@ -756,7 +756,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -777,7 +777,7 @@ def visible(self):
Determines whether or not this 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']
@@ -958,7 +958,7 @@ def __init__(
):
"""
Construct a new Parcats object
-
+
Parallel categories diagram for multidimensional categorical
data.
diff --git a/packages/python/plotly/plotly/graph_objs/_parcoords.py b/packages/python/plotly/plotly/graph_objs/_parcoords.py
index 8221753f085..91ce74c6c8d 100644
--- a/packages/python/plotly/plotly/graph_objs/_parcoords.py
+++ b/packages/python/plotly/plotly/graph_objs/_parcoords.py
@@ -41,7 +41,7 @@ def customdata(self):
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
@@ -62,7 +62,7 @@ def customdatasrc(self):
"""
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
@@ -83,15 +83,15 @@ def dimensions(self):
"""
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
@@ -188,13 +188,13 @@ def dimensiondefaults(self):
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
@@ -217,9 +217,9 @@ def domain(self):
- 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
@@ -252,7 +252,7 @@ def ids(self):
Assigns id labels to 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
@@ -272,7 +272,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -295,7 +295,7 @@ def labelangle(self):
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
@@ -317,17 +317,17 @@ def labelangle(self, val):
def labelfont(self):
"""
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
@@ -366,7 +366,7 @@ def labelside(self):
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']
@@ -391,9 +391,9 @@ def line(self):
- 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
@@ -506,7 +506,7 @@ def meta(self):
access trace `meta` 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
@@ -525,7 +525,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -546,7 +546,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -567,17 +567,17 @@ def name(self, val):
def rangefont(self):
"""
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
@@ -617,9 +617,9 @@ def stream(self):
- 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
@@ -646,17 +646,17 @@ def stream(self, val):
def tickfont(self):
"""
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
@@ -693,7 +693,7 @@ def uid(self):
"""
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
@@ -728,7 +728,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -749,7 +749,7 @@ def visible(self):
Determines whether or not this 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']
@@ -900,7 +900,7 @@ def __init__(
):
"""
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`.
diff --git a/packages/python/plotly/plotly/graph_objs/_pie.py b/packages/python/plotly/plotly/graph_objs/_pie.py
index ada73add70f..314805bf795 100644
--- a/packages/python/plotly/plotly/graph_objs/_pie.py
+++ b/packages/python/plotly/plotly/graph_objs/_pie.py
@@ -69,7 +69,7 @@ class Pie(_BaseTraceType):
def automargin(self):
"""
Determines whether outside text labels can push the margins.
-
+
The 'automargin' property must be specified as a bool
(either True, or False)
@@ -92,7 +92,7 @@ def customdata(self):
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
@@ -113,7 +113,7 @@ def customdatasrc(self):
"""
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
@@ -134,7 +134,7 @@ def direction(self):
"""
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']
@@ -155,7 +155,7 @@ def direction(self, val):
def dlabel(self):
"""
Sets the label step. See `label0` for more info.
-
+
The 'dlabel' property is a number and may be specified as:
- An int or float
@@ -179,9 +179,9 @@ def domain(self):
- 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 .
@@ -212,7 +212,7 @@ def hole(self):
"""
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]
@@ -234,7 +234,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -259,7 +259,7 @@ def hoverinfosrc(self):
"""
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
@@ -283,9 +283,9 @@ def hoverlabel(self):
- 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
@@ -357,7 +357,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -380,7 +380,7 @@ def hovertemplatesrc(self):
"""
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
@@ -404,7 +404,7 @@ def hovertext(self):
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
@@ -427,7 +427,7 @@ def hovertextsrc(self):
"""
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
@@ -449,7 +449,7 @@ def ids(self):
Assigns id labels to 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
@@ -469,7 +469,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -489,17 +489,17 @@ def idssrc(self, val):
def insidetextfont(self):
"""
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 .
@@ -524,7 +524,7 @@ def insidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -552,7 +552,7 @@ def insidetextorientation(self):
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']
@@ -575,7 +575,7 @@ def label0(self):
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
@@ -599,7 +599,7 @@ def labels(self):
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
@@ -619,7 +619,7 @@ def labels(self, val):
def labelssrc(self):
"""
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
@@ -641,7 +641,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -666,9 +666,9 @@ def marker(self):
- 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
@@ -705,7 +705,7 @@ def meta(self):
access trace `meta` 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
@@ -724,7 +724,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -745,7 +745,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -766,7 +766,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -786,17 +786,17 @@ def opacity(self, val):
def outsidetextfont(self):
"""
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 .
@@ -821,7 +821,7 @@ def outsidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -845,7 +845,7 @@ def pull(self):
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
@@ -866,7 +866,7 @@ def pull(self, val):
def pullsrc(self):
"""
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
@@ -887,7 +887,7 @@ def rotation(self):
"""
Instead of the first slice starting at 12 o'clock, rotate to
some other angle.
-
+
The 'rotation' property is a number and may be specified as:
- An int or float in the interval [-360, 360]
@@ -909,7 +909,7 @@ def scalegroup(self):
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
@@ -931,7 +931,7 @@ def showlegend(self):
"""
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)
@@ -952,7 +952,7 @@ def sort(self):
"""
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)
@@ -976,9 +976,9 @@ def stream(self):
- 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
@@ -1009,7 +1009,7 @@ def text(self):
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
@@ -1029,17 +1029,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1064,7 +1064,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1085,7 +1085,7 @@ def textfont(self, val):
def textinfo(self):
"""
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
@@ -1108,7 +1108,7 @@ def textinfo(self, val):
def textposition(self):
"""
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']
@@ -1131,7 +1131,7 @@ def textpositionsrc(self):
"""
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
@@ -1151,7 +1151,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1184,7 +1184,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1207,7 +1207,7 @@ def texttemplatesrc(self):
"""
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
@@ -1231,9 +1231,9 @@ def title(self):
- 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
@@ -1267,17 +1267,17 @@ def titlefont(self):
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 .
@@ -1302,14 +1302,14 @@ def titlefont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1325,7 +1325,7 @@ def titleposition(self):
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',
@@ -1333,7 +1333,7 @@ def titleposition(self):
Returns
-------
-
+
"""
return self["titleposition"]
@@ -1348,7 +1348,7 @@ def uid(self):
"""
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
@@ -1383,7 +1383,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1403,7 +1403,7 @@ def values(self):
"""
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
@@ -1423,7 +1423,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -1445,7 +1445,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1776,7 +1776,7 @@ def __init__(
):
"""
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`
diff --git a/packages/python/plotly/plotly/graph_objs/_pointcloud.py b/packages/python/plotly/plotly/graph_objs/_pointcloud.py
index d6cacdd0805..30603e402ad 100644
--- a/packages/python/plotly/plotly/graph_objs/_pointcloud.py
+++ b/packages/python/plotly/plotly/graph_objs/_pointcloud.py
@@ -55,7 +55,7 @@ def customdata(self):
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
@@ -76,7 +76,7 @@ def customdatasrc(self):
"""
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
@@ -98,7 +98,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -123,7 +123,7 @@ def hoverinfosrc(self):
"""
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
@@ -147,9 +147,9 @@ def hoverlabel(self):
- 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
@@ -204,7 +204,7 @@ def ids(self):
Assigns id labels to 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
@@ -224,7 +224,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -250,7 +250,7 @@ def indices(self):
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
@@ -270,7 +270,7 @@ def indices(self, val):
def indicessrc(self):
"""
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
@@ -292,7 +292,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -317,9 +317,9 @@ def marker(self):
- 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
@@ -377,7 +377,7 @@ def meta(self):
access trace `meta` 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
@@ -396,7 +396,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -417,7 +417,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -438,7 +438,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -459,7 +459,7 @@ def showlegend(self):
"""
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)
@@ -483,9 +483,9 @@ def stream(self):
- 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
@@ -517,7 +517,7 @@ def text(self):
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
@@ -539,7 +539,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -560,7 +560,7 @@ def uid(self):
"""
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
@@ -595,7 +595,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -616,7 +616,7 @@ def visible(self):
Determines whether or not this 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']
@@ -637,7 +637,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -660,7 +660,7 @@ def xaxis(self):
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
@@ -684,7 +684,7 @@ def xbounds(self):
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
@@ -704,7 +704,7 @@ def xbounds(self, val):
def xboundssrc(self):
"""
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
@@ -724,7 +724,7 @@ def xboundssrc(self, val):
def xsrc(self):
"""
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
@@ -747,7 +747,7 @@ def xy(self):
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
@@ -767,7 +767,7 @@ def xy(self, val):
def xysrc(self):
"""
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
@@ -787,7 +787,7 @@ def xysrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -810,7 +810,7 @@ def yaxis(self):
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
@@ -834,7 +834,7 @@ def ybounds(self):
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
@@ -854,7 +854,7 @@ def ybounds(self, val):
def yboundssrc(self):
"""
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
@@ -874,7 +874,7 @@ def yboundssrc(self, val):
def ysrc(self):
"""
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
@@ -1096,7 +1096,7 @@ def __init__(
):
"""
Construct a new Pointcloud object
-
+
The data visualized as a point cloud set in `x` and `y` using
the WebGl plotting engine.
diff --git a/packages/python/plotly/plotly/graph_objs/_sankey.py b/packages/python/plotly/plotly/graph_objs/_sankey.py
index ea50ea5b773..51bae48f735 100644
--- a/packages/python/plotly/plotly/graph_objs/_sankey.py
+++ b/packages/python/plotly/plotly/graph_objs/_sankey.py
@@ -46,7 +46,7 @@ def arrangement(self):
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']
@@ -70,7 +70,7 @@ def customdata(self):
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
@@ -91,7 +91,7 @@ def customdatasrc(self):
"""
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
@@ -115,9 +115,9 @@ def domain(self):
- 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 .
@@ -151,7 +151,7 @@ def hoverinfo(self):
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
@@ -178,9 +178,9 @@ def hoverlabel(self):
- 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
@@ -235,7 +235,7 @@ def ids(self):
Assigns id labels to 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
@@ -255,7 +255,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -275,15 +275,15 @@ def idssrc(self, val):
def link(self):
"""
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:
-
+
color
Sets the `link` color. It can be a single
value, or an array for specifying color for
@@ -401,7 +401,7 @@ def meta(self):
access trace `meta` 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
@@ -420,7 +420,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -441,7 +441,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -462,15 +462,15 @@ def name(self, val):
def node(self):
"""
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:
-
+
color
Sets the `node` color. It can be a single
value, or an array for specifying color for
@@ -572,7 +572,7 @@ def node(self, val):
def orientation(self):
"""
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']
@@ -598,7 +598,7 @@ def selectedpoints(self):
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
@@ -621,9 +621,9 @@ def stream(self):
- 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
@@ -650,17 +650,17 @@ def stream(self, val):
def textfont(self):
"""
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
@@ -697,7 +697,7 @@ def uid(self):
"""
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
@@ -732,7 +732,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -754,7 +754,7 @@ def valueformat(self):
language which is similar to those of Python. See
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'valueformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -776,7 +776,7 @@ def valuesuffix(self):
"""
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
@@ -799,7 +799,7 @@ def visible(self):
Determines whether or not this 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']
@@ -965,7 +965,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_scatter.py b/packages/python/plotly/plotly/graph_objs/_scatter.py
index 53489423f8b..91349da1493 100644
--- a/packages/python/plotly/plotly/graph_objs/_scatter.py
+++ b/packages/python/plotly/plotly/graph_objs/_scatter.py
@@ -88,7 +88,7 @@ def cliponaxis(self):
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)
@@ -109,7 +109,7 @@ def connectgaps(self):
"""
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)
@@ -132,7 +132,7 @@ def customdata(self):
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
@@ -153,7 +153,7 @@ def customdatasrc(self):
"""
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
@@ -173,7 +173,7 @@ def customdatasrc(self, val):
def dx(self):
"""
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
@@ -193,7 +193,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -217,9 +217,9 @@ def error_x(self):
- 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
@@ -238,7 +238,7 @@ def error_x(self):
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
@@ -247,9 +247,9 @@ def error_x(self):
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
@@ -298,9 +298,9 @@ def error_y(self):
- 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
@@ -326,9 +326,9 @@ def error_y(self):
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
@@ -391,7 +391,7 @@ def fill(self):
`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',
@@ -415,7 +415,7 @@ def fillcolor(self):
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)')
@@ -482,7 +482,7 @@ def groupnorm(self):
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']
@@ -505,7 +505,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -530,7 +530,7 @@ def hoverinfosrc(self):
"""
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
@@ -554,9 +554,9 @@ def hoverlabel(self):
- 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
@@ -612,7 +612,7 @@ def hoveron(self):
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
@@ -652,7 +652,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -675,7 +675,7 @@ def hovertemplatesrc(self):
"""
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
@@ -699,7 +699,7 @@ def hovertext(self):
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
@@ -722,7 +722,7 @@ def hovertextsrc(self):
"""
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
@@ -744,7 +744,7 @@ def ids(self):
Assigns id labels to 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
@@ -764,7 +764,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -786,7 +786,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -811,9 +811,9 @@ def line(self):
- 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:
-
+
color
Sets the line color.
dash
@@ -860,9 +860,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -1019,7 +1019,7 @@ def meta(self):
access trace `meta` 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
@@ -1038,7 +1038,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1063,7 +1063,7 @@ def mode(self):
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
@@ -1087,7 +1087,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1108,7 +1108,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -1133,7 +1133,7 @@ def orientation(self):
`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']
@@ -1156,7 +1156,7 @@ def r(self):
r coordinates in scatter traces are deprecated!Please switch to
the "scatterpolar" trace type.Sets the radial coordinatesfor
legacy polar chart only.
-
+
The 'r' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1176,7 +1176,7 @@ def r(self, val):
def rsrc(self):
"""
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
@@ -1200,9 +1200,9 @@ def selected(self):
- 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
@@ -1233,7 +1233,7 @@ def selectedpoints(self):
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
@@ -1253,7 +1253,7 @@ def showlegend(self):
"""
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)
@@ -1280,7 +1280,7 @@ def stackgaps(self):
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']
@@ -1312,7 +1312,7 @@ def stackgroup(self):
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
@@ -1337,9 +1337,9 @@ def stream(self):
- 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
@@ -1368,7 +1368,7 @@ def t(self):
t coordinates in scatter traces are deprecated!Please switch to
the "scatterpolar" trace type.Sets the angular coordinatesfor
legacy polar chart only.
-
+
The 't' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1393,7 +1393,7 @@ def text(self):
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
@@ -1415,17 +1415,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1450,7 +1450,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1472,7 +1472,7 @@ def textposition(self):
"""
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',
@@ -1497,7 +1497,7 @@ def textpositionsrc(self):
"""
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
@@ -1517,7 +1517,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1549,7 +1549,7 @@ def texttemplate(self):
format#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
@@ -1572,7 +1572,7 @@ def texttemplatesrc(self):
"""
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
@@ -1592,7 +1592,7 @@ def texttemplatesrc(self, val):
def tsrc(self):
"""
Sets the source reference on Chart Studio Cloud for t .
-
+
The 'tsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1613,7 +1613,7 @@ def uid(self):
"""
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
@@ -1648,7 +1648,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1671,9 +1671,9 @@ def unselected(self):
- 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
@@ -1701,7 +1701,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1722,7 +1722,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1744,7 +1744,7 @@ def x0(self):
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
@@ -1766,7 +1766,7 @@ def xaxis(self):
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
@@ -1788,7 +1788,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1879,7 +1879,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1899,7 +1899,7 @@ def xsrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1921,7 +1921,7 @@ def y0(self):
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
@@ -1943,7 +1943,7 @@ def yaxis(self):
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
@@ -1965,7 +1965,7 @@ def yaxis(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -2056,7 +2056,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -2511,7 +2511,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_scatter3d.py b/packages/python/plotly/plotly/graph_objs/_scatter3d.py
index 7fa30ee04ae..1e972df9f61 100644
--- a/packages/python/plotly/plotly/graph_objs/_scatter3d.py
+++ b/packages/python/plotly/plotly/graph_objs/_scatter3d.py
@@ -67,7 +67,7 @@ def connectgaps(self):
"""
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)
@@ -90,7 +90,7 @@ def customdata(self):
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
@@ -111,7 +111,7 @@ def customdatasrc(self):
"""
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
@@ -135,9 +135,9 @@ def error_x(self):
- 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
@@ -156,7 +156,7 @@ def error_x(self):
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
@@ -165,9 +165,9 @@ def error_x(self):
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
@@ -216,9 +216,9 @@ def error_y(self):
- 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
@@ -237,7 +237,7 @@ def error_y(self):
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
@@ -246,9 +246,9 @@ def error_y(self):
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
@@ -297,9 +297,9 @@ def error_z(self):
- 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
@@ -325,9 +325,9 @@ def error_z(self):
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
@@ -374,7 +374,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -399,7 +399,7 @@ def hoverinfosrc(self):
"""
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
@@ -423,9 +423,9 @@ def hoverlabel(self):
- 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
@@ -496,7 +496,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -519,7 +519,7 @@ def hovertemplatesrc(self):
"""
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
@@ -543,7 +543,7 @@ def hovertext(self):
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
@@ -566,7 +566,7 @@ def hovertextsrc(self):
"""
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
@@ -588,7 +588,7 @@ def ids(self):
Assigns id labels to 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
@@ -608,7 +608,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -630,7 +630,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -655,9 +655,9 @@ def line(self):
- 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
@@ -769,9 +769,9 @@ def marker(self):
- 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
@@ -919,7 +919,7 @@ def meta(self):
access trace `meta` 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
@@ -938,7 +938,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -963,7 +963,7 @@ def mode(self):
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
@@ -987,7 +987,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1008,7 +1008,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -1032,9 +1032,9 @@ def projection(self):
- 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
@@ -1067,7 +1067,7 @@ def scene(self):
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
@@ -1090,7 +1090,7 @@ def showlegend(self):
"""
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)
@@ -1114,9 +1114,9 @@ def stream(self):
- 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
@@ -1145,7 +1145,7 @@ def surfaceaxis(self):
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]
@@ -1166,7 +1166,7 @@ def surfaceaxis(self, val):
def surfacecolor(self):
"""
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)')
@@ -1230,7 +1230,7 @@ def text(self):
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
@@ -1256,11 +1256,11 @@ def textfont(self):
- 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 .
@@ -1282,7 +1282,7 @@ def textfont(self):
Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1304,7 +1304,7 @@ def textposition(self):
"""
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',
@@ -1329,7 +1329,7 @@ def textpositionsrc(self):
"""
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
@@ -1349,7 +1349,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1381,7 +1381,7 @@ def texttemplate(self):
format#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
@@ -1404,7 +1404,7 @@ def texttemplatesrc(self):
"""
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
@@ -1425,7 +1425,7 @@ def uid(self):
"""
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
@@ -1460,7 +1460,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1481,7 +1481,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1502,7 +1502,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1522,7 +1522,7 @@ def x(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1546,7 +1546,7 @@ def xcalendar(self, val):
def xsrc(self):
"""
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
@@ -1566,7 +1566,7 @@ def xsrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1586,7 +1586,7 @@ def y(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1610,7 +1610,7 @@ def ycalendar(self, val):
def ysrc(self):
"""
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
@@ -1630,7 +1630,7 @@ def ysrc(self, val):
def z(self):
"""
Sets the z coordinates.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1650,7 +1650,7 @@ def z(self, val):
def zcalendar(self):
"""
Sets the calendar system to use with `z` date data.
-
+
The 'zcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1674,7 +1674,7 @@ def zcalendar(self, val):
def zsrc(self):
"""
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
@@ -1974,7 +1974,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_scattercarpet.py b/packages/python/plotly/plotly/graph_objs/_scattercarpet.py
index 61793f285c5..01192f85256 100644
--- a/packages/python/plotly/plotly/graph_objs/_scattercarpet.py
+++ b/packages/python/plotly/plotly/graph_objs/_scattercarpet.py
@@ -63,7 +63,7 @@ class Scattercarpet(_BaseTraceType):
def a(self):
"""
Sets the a-axis coordinates.
-
+
The 'a' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -83,7 +83,7 @@ def a(self, val):
def asrc(self):
"""
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
@@ -103,7 +103,7 @@ def asrc(self, val):
def b(self):
"""
Sets the b-axis coordinates.
-
+
The 'b' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -123,7 +123,7 @@ def b(self, val):
def bsrc(self):
"""
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
@@ -145,7 +145,7 @@ def carpet(self):
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
@@ -167,7 +167,7 @@ def connectgaps(self):
"""
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)
@@ -190,7 +190,7 @@ def customdata(self):
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
@@ -211,7 +211,7 @@ def customdatasrc(self):
"""
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
@@ -239,7 +239,7 @@ def fill(self):
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']
@@ -262,7 +262,7 @@ def fillcolor(self):
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)')
@@ -323,7 +323,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -348,7 +348,7 @@ def hoverinfosrc(self):
"""
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
@@ -372,9 +372,9 @@ def hoverlabel(self):
- 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
@@ -430,7 +430,7 @@ def hoveron(self):
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
@@ -470,7 +470,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -493,7 +493,7 @@ def hovertemplatesrc(self):
"""
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
@@ -517,7 +517,7 @@ def hovertext(self):
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
@@ -540,7 +540,7 @@ def hovertextsrc(self):
"""
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
@@ -562,7 +562,7 @@ def ids(self):
Assigns id labels to 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
@@ -582,7 +582,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -604,7 +604,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -629,9 +629,9 @@ def line(self):
- 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:
-
+
color
Sets the line color.
dash
@@ -672,9 +672,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -832,7 +832,7 @@ def meta(self):
access trace `meta` 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
@@ -851,7 +851,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -876,7 +876,7 @@ def mode(self):
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
@@ -900,7 +900,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -921,7 +921,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -945,9 +945,9 @@ def selected(self):
- 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
@@ -978,7 +978,7 @@ def selectedpoints(self):
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
@@ -998,7 +998,7 @@ def showlegend(self):
"""
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)
@@ -1022,9 +1022,9 @@ def stream(self):
- 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
@@ -1056,7 +1056,7 @@ def text(self):
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
@@ -1078,17 +1078,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1113,7 +1113,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1135,7 +1135,7 @@ def textposition(self):
"""
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',
@@ -1160,7 +1160,7 @@ def textpositionsrc(self):
"""
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
@@ -1180,7 +1180,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1213,7 +1213,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1236,7 +1236,7 @@ def texttemplatesrc(self):
"""
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
@@ -1257,7 +1257,7 @@ def uid(self):
"""
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
@@ -1292,7 +1292,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1315,9 +1315,9 @@ def unselected(self):
- 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
@@ -1345,7 +1345,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1369,7 +1369,7 @@ def xaxis(self):
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
@@ -1394,7 +1394,7 @@ def yaxis(self):
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
@@ -1705,7 +1705,7 @@ def __init__(
):
"""
Construct a new Scattercarpet object
-
+
Plots a scatter trace on either the first carpet axis or the
carpet axis with a matching `carpet` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/_scattergeo.py b/packages/python/plotly/plotly/graph_objs/_scattergeo.py
index 7d8f05d833a..3e759d75ed5 100644
--- a/packages/python/plotly/plotly/graph_objs/_scattergeo.py
+++ b/packages/python/plotly/plotly/graph_objs/_scattergeo.py
@@ -66,7 +66,7 @@ def connectgaps(self):
"""
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)
@@ -89,7 +89,7 @@ def customdata(self):
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
@@ -110,7 +110,7 @@ def customdatasrc(self):
"""
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
@@ -133,7 +133,7 @@ def featureidkey(self):
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
@@ -156,7 +156,7 @@ def fill(self):
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']
@@ -179,7 +179,7 @@ def fillcolor(self):
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)')
@@ -241,7 +241,7 @@ def geo(self):
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
@@ -268,7 +268,7 @@ def geojson(self):
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
@@ -289,7 +289,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -314,7 +314,7 @@ def hoverinfosrc(self):
"""
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
@@ -338,9 +338,9 @@ def hoverlabel(self):
- 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
@@ -411,7 +411,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -434,7 +434,7 @@ def hovertemplatesrc(self):
"""
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
@@ -459,7 +459,7 @@ def hovertext(self):
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
@@ -482,7 +482,7 @@ def hovertextsrc(self):
"""
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
@@ -504,7 +504,7 @@ def ids(self):
Assigns id labels to 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
@@ -524,7 +524,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -544,7 +544,7 @@ def idssrc(self, val):
def lat(self):
"""
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
@@ -564,7 +564,7 @@ def lat(self, val):
def latsrc(self):
"""
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
@@ -586,7 +586,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -611,9 +611,9 @@ def line(self):
- 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
@@ -644,7 +644,7 @@ def locationmode(self):
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']
@@ -667,7 +667,7 @@ def locations(self):
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
@@ -688,7 +688,7 @@ def locationssrc(self):
"""
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
@@ -708,7 +708,7 @@ def locationssrc(self, val):
def lon(self):
"""
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
@@ -728,7 +728,7 @@ def lon(self, val):
def lonsrc(self):
"""
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
@@ -752,9 +752,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -909,7 +909,7 @@ def meta(self):
access trace `meta` 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
@@ -928,7 +928,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -953,7 +953,7 @@ def mode(self):
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
@@ -977,7 +977,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -998,7 +998,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -1022,9 +1022,9 @@ def selected(self):
- 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
@@ -1055,7 +1055,7 @@ def selectedpoints(self):
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
@@ -1075,7 +1075,7 @@ def showlegend(self):
"""
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)
@@ -1099,9 +1099,9 @@ def stream(self):
- 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
@@ -1134,7 +1134,7 @@ def text(self):
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
@@ -1156,17 +1156,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1191,7 +1191,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1213,7 +1213,7 @@ def textposition(self):
"""
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',
@@ -1238,7 +1238,7 @@ def textpositionsrc(self):
"""
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
@@ -1258,7 +1258,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1291,7 +1291,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1314,7 +1314,7 @@ def texttemplatesrc(self):
"""
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
@@ -1335,7 +1335,7 @@ def uid(self):
"""
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
@@ -1370,7 +1370,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1393,9 +1393,9 @@ def unselected(self):
- 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
@@ -1423,7 +1423,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1744,7 +1744,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_scattergl.py b/packages/python/plotly/plotly/graph_objs/_scattergl.py
index e33f3bf1122..8634f37193d 100644
--- a/packages/python/plotly/plotly/graph_objs/_scattergl.py
+++ b/packages/python/plotly/plotly/graph_objs/_scattergl.py
@@ -76,7 +76,7 @@ def connectgaps(self):
"""
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)
@@ -99,7 +99,7 @@ def customdata(self):
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
@@ -120,7 +120,7 @@ def customdatasrc(self):
"""
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
@@ -140,7 +140,7 @@ def customdatasrc(self, val):
def dx(self):
"""
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
@@ -160,7 +160,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -184,9 +184,9 @@ def error_x(self):
- 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
@@ -205,7 +205,7 @@ def error_x(self):
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
@@ -214,9 +214,9 @@ def error_x(self):
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
@@ -265,9 +265,9 @@ def error_y(self):
- 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
@@ -293,9 +293,9 @@ def error_y(self):
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
@@ -358,7 +358,7 @@ def fill(self):
`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',
@@ -382,7 +382,7 @@ def fillcolor(self):
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)')
@@ -443,7 +443,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -468,7 +468,7 @@ def hoverinfosrc(self):
"""
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
@@ -492,9 +492,9 @@ def hoverlabel(self):
- 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
@@ -565,7 +565,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -588,7 +588,7 @@ def hovertemplatesrc(self):
"""
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
@@ -612,7 +612,7 @@ def hovertext(self):
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
@@ -635,7 +635,7 @@ def hovertextsrc(self):
"""
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
@@ -657,7 +657,7 @@ def ids(self):
Assigns id labels to 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
@@ -677,7 +677,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -699,7 +699,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -724,9 +724,9 @@ def line(self):
- 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
@@ -757,9 +757,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -910,7 +910,7 @@ def meta(self):
access trace `meta` 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
@@ -929,7 +929,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -949,7 +949,7 @@ def metasrc(self, val):
def mode(self):
"""
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
@@ -973,7 +973,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -994,7 +994,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -1018,9 +1018,9 @@ def selected(self):
- 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
@@ -1051,7 +1051,7 @@ def selectedpoints(self):
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
@@ -1071,7 +1071,7 @@ def showlegend(self):
"""
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)
@@ -1095,9 +1095,9 @@ def stream(self):
- 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
@@ -1129,7 +1129,7 @@ def text(self):
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
@@ -1151,17 +1151,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1186,7 +1186,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1208,7 +1208,7 @@ def textposition(self):
"""
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',
@@ -1233,7 +1233,7 @@ def textpositionsrc(self):
"""
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
@@ -1253,7 +1253,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1285,7 +1285,7 @@ def texttemplate(self):
format#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
@@ -1308,7 +1308,7 @@ def texttemplatesrc(self):
"""
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
@@ -1329,7 +1329,7 @@ def uid(self):
"""
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
@@ -1364,7 +1364,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1387,9 +1387,9 @@ def unselected(self):
- 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
@@ -1417,7 +1417,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1438,7 +1438,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1460,7 +1460,7 @@ def x0(self):
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
@@ -1482,7 +1482,7 @@ def xaxis(self):
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
@@ -1504,7 +1504,7 @@ def xaxis(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1595,7 +1595,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1615,7 +1615,7 @@ def xsrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1637,7 +1637,7 @@ def y0(self):
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
@@ -1659,7 +1659,7 @@ def yaxis(self):
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
@@ -1681,7 +1681,7 @@ def yaxis(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1772,7 +1772,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -2144,7 +2144,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_scattermapbox.py b/packages/python/plotly/plotly/graph_objs/_scattermapbox.py
index 9f1f5a60a9e..7848b91d400 100644
--- a/packages/python/plotly/plotly/graph_objs/_scattermapbox.py
+++ b/packages/python/plotly/plotly/graph_objs/_scattermapbox.py
@@ -64,7 +64,7 @@ def below(self):
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
@@ -86,7 +86,7 @@ def connectgaps(self):
"""
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)
@@ -109,7 +109,7 @@ def customdata(self):
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
@@ -130,7 +130,7 @@ def customdatasrc(self):
"""
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
@@ -152,7 +152,7 @@ def fill(self):
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']
@@ -175,7 +175,7 @@ def fillcolor(self):
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)')
@@ -236,7 +236,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -261,7 +261,7 @@ def hoverinfosrc(self):
"""
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
@@ -285,9 +285,9 @@ def hoverlabel(self):
- 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
@@ -358,7 +358,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -381,7 +381,7 @@ def hovertemplatesrc(self):
"""
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
@@ -405,7 +405,7 @@ def hovertext(self):
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
@@ -428,7 +428,7 @@ def hovertextsrc(self):
"""
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
@@ -450,7 +450,7 @@ def ids(self):
Assigns id labels to 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
@@ -470,7 +470,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -490,7 +490,7 @@ def idssrc(self, val):
def lat(self):
"""
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
@@ -510,7 +510,7 @@ def lat(self, val):
def latsrc(self):
"""
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
@@ -532,7 +532,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -557,9 +557,9 @@ def line(self):
- 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
@@ -581,7 +581,7 @@ def line(self, val):
def lon(self):
"""
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
@@ -601,7 +601,7 @@ def lon(self, val):
def lonsrc(self):
"""
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
@@ -625,9 +625,9 @@ def marker(self):
- 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
@@ -783,7 +783,7 @@ def meta(self):
access trace `meta` 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
@@ -802,7 +802,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -825,7 +825,7 @@ def mode(self):
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
@@ -849,7 +849,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -870,7 +870,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -894,9 +894,9 @@ def selected(self):
- 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
@@ -923,7 +923,7 @@ def selectedpoints(self):
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
@@ -943,7 +943,7 @@ def showlegend(self):
"""
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)
@@ -967,9 +967,9 @@ def stream(self):
- 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
@@ -999,7 +999,7 @@ def subplot(self):
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
@@ -1026,7 +1026,7 @@ def text(self):
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
@@ -1050,17 +1050,17 @@ def textfont(self):
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
@@ -1097,7 +1097,7 @@ def textposition(self):
"""
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',
@@ -1120,7 +1120,7 @@ def textposition(self, val):
def textsrc(self):
"""
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
@@ -1153,7 +1153,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1176,7 +1176,7 @@ def texttemplatesrc(self):
"""
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
@@ -1197,7 +1197,7 @@ def uid(self):
"""
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
@@ -1232,7 +1232,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1255,9 +1255,9 @@ def unselected(self):
- 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
@@ -1281,7 +1281,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1571,7 +1571,7 @@ def __init__(
):
"""
Construct a new Scattermapbox object
-
+
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`.
diff --git a/packages/python/plotly/plotly/graph_objs/_scatterpolar.py b/packages/python/plotly/plotly/graph_objs/_scatterpolar.py
index bc46cd35525..2d51acb37da 100644
--- a/packages/python/plotly/plotly/graph_objs/_scatterpolar.py
+++ b/packages/python/plotly/plotly/graph_objs/_scatterpolar.py
@@ -70,7 +70,7 @@ def cliponaxis(self):
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)
@@ -91,7 +91,7 @@ def connectgaps(self):
"""
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)
@@ -114,7 +114,7 @@ def customdata(self):
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
@@ -135,7 +135,7 @@ def customdatasrc(self):
"""
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
@@ -155,7 +155,7 @@ def customdatasrc(self, val):
def dr(self):
"""
Sets the r coordinate step.
-
+
The 'dr' property is a number and may be specified as:
- An int or float
@@ -177,7 +177,7 @@ def dtheta(self):
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
@@ -205,7 +205,7 @@ def fill(self):
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']
@@ -228,7 +228,7 @@ def fillcolor(self):
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)')
@@ -289,7 +289,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -314,7 +314,7 @@ def hoverinfosrc(self):
"""
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
@@ -338,9 +338,9 @@ def hoverlabel(self):
- 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
@@ -396,7 +396,7 @@ def hoveron(self):
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
@@ -436,7 +436,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -459,7 +459,7 @@ def hovertemplatesrc(self):
"""
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
@@ -483,7 +483,7 @@ def hovertext(self):
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
@@ -506,7 +506,7 @@ def hovertextsrc(self):
"""
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
@@ -528,7 +528,7 @@ def ids(self):
Assigns id labels to 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
@@ -548,7 +548,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -570,7 +570,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -595,9 +595,9 @@ def line(self):
- 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:
-
+
color
Sets the line color.
dash
@@ -638,9 +638,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -798,7 +798,7 @@ def meta(self):
access trace `meta` 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
@@ -817,7 +817,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -842,7 +842,7 @@ def mode(self):
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
@@ -866,7 +866,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -887,7 +887,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -907,7 +907,7 @@ def opacity(self, val):
def r(self):
"""
Sets the radial coordinates
-
+
The 'r' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -929,7 +929,7 @@ def r0(self):
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
@@ -948,7 +948,7 @@ def r0(self, val):
def rsrc(self):
"""
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
@@ -972,9 +972,9 @@ def selected(self):
- 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
@@ -1005,7 +1005,7 @@ def selectedpoints(self):
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
@@ -1025,7 +1025,7 @@ def showlegend(self):
"""
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)
@@ -1049,9 +1049,9 @@ def stream(self):
- 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
@@ -1081,7 +1081,7 @@ def subplot(self):
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
@@ -1108,7 +1108,7 @@ def text(self):
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
@@ -1130,17 +1130,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1165,7 +1165,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1187,7 +1187,7 @@ def textposition(self):
"""
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',
@@ -1212,7 +1212,7 @@ def textpositionsrc(self):
"""
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
@@ -1232,7 +1232,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1265,7 +1265,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1288,7 +1288,7 @@ def texttemplatesrc(self):
"""
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
@@ -1308,7 +1308,7 @@ def texttemplatesrc(self, val):
def theta(self):
"""
Sets the angular coordinates
-
+
The 'theta' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1330,7 +1330,7 @@ def theta0(self):
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
@@ -1349,7 +1349,7 @@ def theta0(self, val):
def thetasrc(self):
"""
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
@@ -1370,7 +1370,7 @@ def thetaunit(self):
"""
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']
@@ -1392,7 +1392,7 @@ def uid(self):
"""
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
@@ -1427,7 +1427,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1450,9 +1450,9 @@ def unselected(self):
- 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
@@ -1480,7 +1480,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1809,7 +1809,7 @@ def __init__(
):
"""
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`
diff --git a/packages/python/plotly/plotly/graph_objs/_scatterpolargl.py b/packages/python/plotly/plotly/graph_objs/_scatterpolargl.py
index 21d05ac7384..80802c47032 100644
--- a/packages/python/plotly/plotly/graph_objs/_scatterpolargl.py
+++ b/packages/python/plotly/plotly/graph_objs/_scatterpolargl.py
@@ -66,7 +66,7 @@ def connectgaps(self):
"""
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)
@@ -89,7 +89,7 @@ def customdata(self):
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
@@ -110,7 +110,7 @@ def customdatasrc(self):
"""
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
@@ -130,7 +130,7 @@ def customdatasrc(self, val):
def dr(self):
"""
Sets the r coordinate step.
-
+
The 'dr' property is a number and may be specified as:
- An int or float
@@ -152,7 +152,7 @@ def dtheta(self):
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
@@ -190,7 +190,7 @@ def fill(self):
`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',
@@ -214,7 +214,7 @@ def fillcolor(self):
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)')
@@ -275,7 +275,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -300,7 +300,7 @@ def hoverinfosrc(self):
"""
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
@@ -324,9 +324,9 @@ def hoverlabel(self):
- 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
@@ -397,7 +397,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -420,7 +420,7 @@ def hovertemplatesrc(self):
"""
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
@@ -444,7 +444,7 @@ def hovertext(self):
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
@@ -467,7 +467,7 @@ def hovertextsrc(self):
"""
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
@@ -489,7 +489,7 @@ def ids(self):
Assigns id labels to 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
@@ -509,7 +509,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -531,7 +531,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -556,9 +556,9 @@ def line(self):
- 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
@@ -589,9 +589,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -742,7 +742,7 @@ def meta(self):
access trace `meta` 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
@@ -761,7 +761,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -786,7 +786,7 @@ def mode(self):
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
@@ -810,7 +810,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -831,7 +831,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -851,7 +851,7 @@ def opacity(self, val):
def r(self):
"""
Sets the radial coordinates
-
+
The 'r' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -873,7 +873,7 @@ def r0(self):
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
@@ -892,7 +892,7 @@ def r0(self, val):
def rsrc(self):
"""
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
@@ -916,9 +916,9 @@ def selected(self):
- 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
@@ -949,7 +949,7 @@ def selectedpoints(self):
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
@@ -969,7 +969,7 @@ def showlegend(self):
"""
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)
@@ -993,9 +993,9 @@ def stream(self):
- 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
@@ -1025,7 +1025,7 @@ def subplot(self):
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
@@ -1052,7 +1052,7 @@ def text(self):
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
@@ -1074,17 +1074,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1109,7 +1109,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1131,7 +1131,7 @@ def textposition(self):
"""
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',
@@ -1156,7 +1156,7 @@ def textpositionsrc(self):
"""
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
@@ -1176,7 +1176,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1209,7 +1209,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1232,7 +1232,7 @@ def texttemplatesrc(self):
"""
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
@@ -1252,7 +1252,7 @@ def texttemplatesrc(self, val):
def theta(self):
"""
Sets the angular coordinates
-
+
The 'theta' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1274,7 +1274,7 @@ def theta0(self):
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
@@ -1293,7 +1293,7 @@ def theta0(self, val):
def thetasrc(self):
"""
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
@@ -1314,7 +1314,7 @@ def thetaunit(self):
"""
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']
@@ -1336,7 +1336,7 @@ def uid(self):
"""
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
@@ -1371,7 +1371,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1394,9 +1394,9 @@ def unselected(self):
- 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
@@ -1424,7 +1424,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1751,7 +1751,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_scatterternary.py b/packages/python/plotly/plotly/graph_objs/_scatterternary.py
index 11cd2e31a41..a24cc78e375 100644
--- a/packages/python/plotly/plotly/graph_objs/_scatterternary.py
+++ b/packages/python/plotly/plotly/graph_objs/_scatterternary.py
@@ -68,7 +68,7 @@ def a(self):
`b`, and `c` are all provided, they need not be normalized,
only the relative values matter. If only two arrays are
provided they must be normalized to match `ternary.sum`.
-
+
The 'a' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -88,7 +88,7 @@ def a(self, val):
def asrc(self):
"""
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
@@ -111,7 +111,7 @@ def b(self):
`b`, and `c` are all provided, they need not be normalized,
only the relative values matter. If only two arrays are
provided they must be normalized to match `ternary.sum`.
-
+
The 'b' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -131,7 +131,7 @@ def b(self, val):
def bsrc(self):
"""
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
@@ -154,7 +154,7 @@ def c(self):
`b`, and `c` are all provided, they need not be normalized,
only the relative values matter. If only two arrays are
provided they must be normalized to match `ternary.sum`.
-
+
The 'c' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -177,7 +177,7 @@ def cliponaxis(self):
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)
@@ -198,7 +198,7 @@ def connectgaps(self):
"""
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)
@@ -218,7 +218,7 @@ def connectgaps(self, val):
def csrc(self):
"""
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
@@ -241,7 +241,7 @@ def customdata(self):
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
@@ -262,7 +262,7 @@ def customdatasrc(self):
"""
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
@@ -290,7 +290,7 @@ def fill(self):
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']
@@ -313,7 +313,7 @@ def fillcolor(self):
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)')
@@ -374,7 +374,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -399,7 +399,7 @@ def hoverinfosrc(self):
"""
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
@@ -423,9 +423,9 @@ def hoverlabel(self):
- 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
@@ -481,7 +481,7 @@ def hoveron(self):
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
@@ -521,7 +521,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -544,7 +544,7 @@ def hovertemplatesrc(self):
"""
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
@@ -568,7 +568,7 @@ def hovertext(self):
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
@@ -591,7 +591,7 @@ def hovertextsrc(self):
"""
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
@@ -613,7 +613,7 @@ def ids(self):
Assigns id labels to 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
@@ -633,7 +633,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -655,7 +655,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -680,9 +680,9 @@ def line(self):
- 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:
-
+
color
Sets the line color.
dash
@@ -723,9 +723,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -883,7 +883,7 @@ def meta(self):
access trace `meta` 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
@@ -902,7 +902,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -927,7 +927,7 @@ def mode(self):
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
@@ -951,7 +951,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -972,7 +972,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -996,9 +996,9 @@ def selected(self):
- 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
@@ -1029,7 +1029,7 @@ def selectedpoints(self):
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
@@ -1049,7 +1049,7 @@ def showlegend(self):
"""
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)
@@ -1073,9 +1073,9 @@ def stream(self):
- 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
@@ -1105,7 +1105,7 @@ def subplot(self):
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
@@ -1131,7 +1131,7 @@ def sum(self):
normalize this specific trace, but does not affect the values
displayed on the axes. 0 (or missing) means to use
ternary.sum
-
+
The 'sum' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1156,7 +1156,7 @@ def text(self):
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
@@ -1178,17 +1178,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1213,7 +1213,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1235,7 +1235,7 @@ def textposition(self):
"""
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',
@@ -1260,7 +1260,7 @@ def textpositionsrc(self):
"""
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
@@ -1280,7 +1280,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1313,7 +1313,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. 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
@@ -1336,7 +1336,7 @@ def texttemplatesrc(self):
"""
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
@@ -1357,7 +1357,7 @@ def uid(self):
"""
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
@@ -1392,7 +1392,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1415,9 +1415,9 @@ def unselected(self):
- 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
@@ -1445,7 +1445,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1779,7 +1779,7 @@ def __init__(
):
"""
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.
diff --git a/packages/python/plotly/plotly/graph_objs/_splom.py b/packages/python/plotly/plotly/graph_objs/_splom.py
index f3eace32932..15f52c5ebfe 100644
--- a/packages/python/plotly/plotly/graph_objs/_splom.py
+++ b/packages/python/plotly/plotly/graph_objs/_splom.py
@@ -55,7 +55,7 @@ def customdata(self):
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
@@ -76,7 +76,7 @@ def customdatasrc(self):
"""
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
@@ -100,9 +100,9 @@ def diagonal(self):
- 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.
@@ -127,9 +127,9 @@ def dimensions(self):
- 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
@@ -186,13 +186,13 @@ def dimensiondefaults(self):
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
@@ -213,7 +213,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -238,7 +238,7 @@ def hoverinfosrc(self):
"""
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
@@ -262,9 +262,9 @@ def hoverlabel(self):
- 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
@@ -335,7 +335,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -358,7 +358,7 @@ def hovertemplatesrc(self):
"""
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
@@ -378,7 +378,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -401,7 +401,7 @@ def hovertextsrc(self):
"""
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
@@ -423,7 +423,7 @@ def ids(self):
Assigns id labels to 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
@@ -443,7 +443,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -465,7 +465,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -490,9 +490,9 @@ def marker(self):
- 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:
-
+
autocolorscale
Determines whether the colorscale is a default
palette (`autocolorscale: true`) or the palette
@@ -642,7 +642,7 @@ def meta(self):
access trace `meta` 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
@@ -661,7 +661,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -682,7 +682,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -703,7 +703,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -727,9 +727,9 @@ def selected(self):
- 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
@@ -756,7 +756,7 @@ def selectedpoints(self):
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
@@ -776,7 +776,7 @@ def showlegend(self):
"""
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)
@@ -797,7 +797,7 @@ def showlowerhalf(self):
"""
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)
@@ -818,7 +818,7 @@ def showupperhalf(self):
"""
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)
@@ -842,9 +842,9 @@ def stream(self):
- 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
@@ -874,7 +874,7 @@ def text(self):
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
@@ -896,7 +896,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -917,7 +917,7 @@ def uid(self):
"""
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
@@ -952,7 +952,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -975,9 +975,9 @@ def unselected(self):
- 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
@@ -1001,7 +1001,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1027,7 +1027,7 @@ def xaxes(self):
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
@@ -1056,7 +1056,7 @@ def yaxes(self):
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
@@ -1301,7 +1301,7 @@ def __init__(
):
"""
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`.
diff --git a/packages/python/plotly/plotly/graph_objs/_streamtube.py b/packages/python/plotly/plotly/graph_objs/_streamtube.py
index f2632ac2745..3ff89687e69 100644
--- a/packages/python/plotly/plotly/graph_objs/_streamtube.py
+++ b/packages/python/plotly/plotly/graph_objs/_streamtube.py
@@ -72,7 +72,7 @@ def autocolorscale(self):
`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)
@@ -95,7 +95,7 @@ def cauto(self):
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)
@@ -117,7 +117,7 @@ def cmax(self):
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
@@ -140,7 +140,7 @@ def cmid(self):
`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
@@ -162,7 +162,7 @@ def cmin(self):
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
@@ -187,7 +187,7 @@ def coloraxis(self):
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
@@ -213,9 +213,9 @@ def colorbar(self):
- 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
@@ -456,14 +456,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -502,7 +502,7 @@ def customdata(self):
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
@@ -523,7 +523,7 @@ def customdatasrc(self):
"""
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
@@ -545,7 +545,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -570,7 +570,7 @@ def hoverinfosrc(self):
"""
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
@@ -594,9 +594,9 @@ def hoverlabel(self):
- 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
@@ -669,7 +669,7 @@ def hovertemplate(self):
displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -692,7 +692,7 @@ def hovertemplatesrc(self):
"""
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
@@ -712,7 +712,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -735,7 +735,7 @@ def ids(self):
Assigns id labels to 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
@@ -755,7 +755,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -777,7 +777,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -802,9 +802,9 @@ def lighting(self):
- 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.
@@ -850,9 +850,9 @@ def lightposition(self):
- 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.
@@ -879,7 +879,7 @@ def lightposition(self, val):
def maxdisplayed(self):
"""
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]
@@ -909,7 +909,7 @@ def meta(self):
access trace `meta` 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
@@ -928,7 +928,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -949,7 +949,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -975,7 +975,7 @@ def opacity(self):
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]
@@ -997,7 +997,7 @@ def reversescale(self):
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)
@@ -1020,7 +1020,7 @@ def scene(self):
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
@@ -1043,7 +1043,7 @@ def showlegend(self):
"""
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)
@@ -1064,7 +1064,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1086,7 +1086,7 @@ def sizeref(self):
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]
@@ -1110,9 +1110,9 @@ def starts(self):
- 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
@@ -1152,9 +1152,9 @@ def stream(self):
- 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
@@ -1184,7 +1184,7 @@ def text(self):
`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
@@ -1205,7 +1205,7 @@ def text(self, val):
def u(self):
"""
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
@@ -1226,7 +1226,7 @@ def uid(self):
"""
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
@@ -1261,7 +1261,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1280,7 +1280,7 @@ def uirevision(self, val):
def usrc(self):
"""
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
@@ -1300,7 +1300,7 @@ def usrc(self, val):
def v(self):
"""
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
@@ -1322,7 +1322,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1343,7 +1343,7 @@ def visible(self, val):
def vsrc(self):
"""
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
@@ -1363,7 +1363,7 @@ def vsrc(self, val):
def w(self):
"""
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
@@ -1383,7 +1383,7 @@ def w(self, val):
def wsrc(self):
"""
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
@@ -1403,7 +1403,7 @@ def wsrc(self, val):
def x(self):
"""
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
@@ -1423,7 +1423,7 @@ def x(self, val):
def xsrc(self):
"""
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
@@ -1443,7 +1443,7 @@ def xsrc(self, val):
def y(self):
"""
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
@@ -1463,7 +1463,7 @@ def y(self, val):
def ysrc(self):
"""
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
@@ -1483,7 +1483,7 @@ def ysrc(self, val):
def z(self):
"""
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
@@ -1503,7 +1503,7 @@ def z(self, val):
def zsrc(self):
"""
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
@@ -1816,7 +1816,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_sunburst.py b/packages/python/plotly/plotly/graph_objs/_sunburst.py
index f6a833241aa..3ced6ddfd0d 100644
--- a/packages/python/plotly/plotly/graph_objs/_sunburst.py
+++ b/packages/python/plotly/plotly/graph_objs/_sunburst.py
@@ -66,7 +66,7 @@ def branchvalues(self):
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']
@@ -89,7 +89,7 @@ def count(self):
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
@@ -114,7 +114,7 @@ def customdata(self):
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
@@ -135,7 +135,7 @@ def customdatasrc(self):
"""
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
@@ -159,9 +159,9 @@ def domain(self):
- 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
@@ -194,7 +194,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -219,7 +219,7 @@ def hoverinfosrc(self):
"""
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
@@ -243,9 +243,9 @@ def hoverlabel(self):
- 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
@@ -318,7 +318,7 @@ def hovertemplate(self):
displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -341,7 +341,7 @@ def hovertemplatesrc(self):
"""
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
@@ -365,7 +365,7 @@ def hovertext(self):
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
@@ -388,7 +388,7 @@ def hovertextsrc(self):
"""
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
@@ -410,7 +410,7 @@ def ids(self):
Assigns id labels to 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
@@ -430,7 +430,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -450,17 +450,17 @@ def idssrc(self, val):
def insidetextfont(self):
"""
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 .
@@ -485,7 +485,7 @@ def insidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -513,7 +513,7 @@ def insidetextorientation(self):
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']
@@ -534,7 +534,7 @@ def insidetextorientation(self, val):
def labels(self):
"""
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
@@ -554,7 +554,7 @@ def labels(self, val):
def labelssrc(self):
"""
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
@@ -578,9 +578,9 @@ def leaf(self):
- 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
@@ -605,7 +605,7 @@ def level(self):
`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
@@ -628,9 +628,9 @@ def marker(self):
- 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
@@ -736,7 +736,7 @@ def maxdepth(self):
"""
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)
@@ -765,7 +765,7 @@ def meta(self):
access trace `meta` 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
@@ -784,7 +784,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -805,7 +805,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -826,7 +826,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -850,17 +850,17 @@ def outsidetextfont(self):
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 .
@@ -885,7 +885,7 @@ def outsidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -911,7 +911,7 @@ def parents(self):
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
@@ -931,7 +931,7 @@ def parents(self, val):
def parentssrc(self):
"""
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
@@ -999,9 +999,9 @@ def stream(self):
- 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
@@ -1032,7 +1032,7 @@ def text(self):
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
@@ -1052,17 +1052,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1087,7 +1087,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1108,7 +1108,7 @@ def textfont(self, val):
def textinfo(self):
"""
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
@@ -1131,7 +1131,7 @@ def textinfo(self, val):
def textsrc(self):
"""
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
@@ -1165,7 +1165,7 @@ def texttemplate(self):
are `arrayOk: true`) are available. 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
@@ -1188,7 +1188,7 @@ def texttemplatesrc(self):
"""
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
@@ -1209,7 +1209,7 @@ def uid(self):
"""
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
@@ -1244,7 +1244,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1264,7 +1264,7 @@ def values(self):
"""
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
@@ -1284,7 +1284,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -1306,7 +1306,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1608,7 +1608,7 @@ def __init__(
):
"""
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".
diff --git a/packages/python/plotly/plotly/graph_objs/_surface.py b/packages/python/plotly/plotly/graph_objs/_surface.py
index fb9051b3ff2..55cb2eda6cf 100644
--- a/packages/python/plotly/plotly/graph_objs/_surface.py
+++ b/packages/python/plotly/plotly/graph_objs/_surface.py
@@ -74,7 +74,7 @@ def autocolorscale(self):
`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)
@@ -97,7 +97,7 @@ def cauto(self):
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)
@@ -119,7 +119,7 @@ def cmax(self):
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
@@ -142,7 +142,7 @@ def cmid(self):
`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
@@ -164,7 +164,7 @@ def cmin(self):
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
@@ -189,7 +189,7 @@ def coloraxis(self):
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
@@ -215,9 +215,9 @@ def colorbar(self):
- 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
@@ -458,14 +458,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -502,7 +502,7 @@ def connectgaps(self):
"""
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)
@@ -526,9 +526,9 @@ def contours(self):
- 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
@@ -558,7 +558,7 @@ def customdata(self):
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
@@ -579,7 +579,7 @@ def customdatasrc(self):
"""
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
@@ -601,7 +601,7 @@ def hidesurface(self):
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)
@@ -623,7 +623,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -648,7 +648,7 @@ def hoverinfosrc(self):
"""
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
@@ -672,9 +672,9 @@ def hoverlabel(self):
- 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
@@ -745,7 +745,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -768,7 +768,7 @@ def hovertemplatesrc(self):
"""
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
@@ -788,7 +788,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -811,7 +811,7 @@ def hovertextsrc(self):
"""
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
@@ -833,7 +833,7 @@ def ids(self):
Assigns id labels to 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
@@ -853,7 +853,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -875,7 +875,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -900,9 +900,9 @@ def lighting(self):
- 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.
@@ -942,9 +942,9 @@ def lightposition(self):
- 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.
@@ -980,7 +980,7 @@ def meta(self):
access trace `meta` 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
@@ -999,7 +999,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1020,7 +1020,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1046,7 +1046,7 @@ def opacity(self):
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]
@@ -1074,7 +1074,7 @@ def opacityscale(self):
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
@@ -1095,7 +1095,7 @@ def reversescale(self):
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)
@@ -1118,7 +1118,7 @@ def scene(self):
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
@@ -1141,7 +1141,7 @@ def showlegend(self):
"""
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)
@@ -1162,7 +1162,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1186,9 +1186,9 @@ def stream(self):
- 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
@@ -1216,7 +1216,7 @@ def surfacecolor(self):
"""
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
@@ -1237,7 +1237,7 @@ def surfacecolorsrc(self):
"""
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
@@ -1259,7 +1259,7 @@ def text(self):
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
@@ -1281,7 +1281,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1302,7 +1302,7 @@ def uid(self):
"""
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
@@ -1337,7 +1337,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1358,7 +1358,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1379,7 +1379,7 @@ def visible(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1399,7 +1399,7 @@ def x(self, val):
def xcalendar(self):
"""
Sets the calendar system to use with `x` date data.
-
+
The 'xcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1423,7 +1423,7 @@ def xcalendar(self, val):
def xsrc(self):
"""
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
@@ -1443,7 +1443,7 @@ def xsrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1463,7 +1463,7 @@ def y(self, val):
def ycalendar(self):
"""
Sets the calendar system to use with `y` date data.
-
+
The 'ycalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1487,7 +1487,7 @@ def ycalendar(self, val):
def ysrc(self):
"""
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
@@ -1507,7 +1507,7 @@ def ysrc(self, val):
def z(self):
"""
Sets the z coordinates.
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1527,7 +1527,7 @@ def z(self, val):
def zcalendar(self):
"""
Sets the calendar system to use with `z` date data.
-
+
The 'zcalendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -1551,7 +1551,7 @@ def zcalendar(self, val):
def zsrc(self):
"""
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
@@ -1879,7 +1879,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_table.py b/packages/python/plotly/plotly/graph_objs/_table.py
index 0680ac93148..e471b90bcaa 100644
--- a/packages/python/plotly/plotly/graph_objs/_table.py
+++ b/packages/python/plotly/plotly/graph_objs/_table.py
@@ -43,9 +43,9 @@ def cells(self):
- 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`
@@ -115,7 +115,7 @@ def columnorder(self):
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
@@ -136,7 +136,7 @@ def columnordersrc(self):
"""
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
@@ -157,7 +157,7 @@ def columnwidth(self):
"""
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
@@ -179,7 +179,7 @@ def columnwidthsrc(self):
"""
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
@@ -202,7 +202,7 @@ def customdata(self):
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
@@ -223,7 +223,7 @@ def customdatasrc(self):
"""
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
@@ -247,9 +247,9 @@ def domain(self):
- 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 .
@@ -283,9 +283,9 @@ def header(self):
- 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`
@@ -354,7 +354,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -379,7 +379,7 @@ def hoverinfosrc(self):
"""
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
@@ -403,9 +403,9 @@ def hoverlabel(self):
- 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
@@ -460,7 +460,7 @@ def ids(self):
Assigns id labels to 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
@@ -480,7 +480,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -509,7 +509,7 @@ def meta(self):
access trace `meta` 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
@@ -528,7 +528,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -549,7 +549,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -574,9 +574,9 @@ def stream(self):
- 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
@@ -604,7 +604,7 @@ def uid(self):
"""
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
@@ -639,7 +639,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -660,7 +660,7 @@ def visible(self):
Determines whether or not this 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']
@@ -815,7 +815,7 @@ def __init__(
):
"""
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-
diff --git a/packages/python/plotly/plotly/graph_objs/_treemap.py b/packages/python/plotly/plotly/graph_objs/_treemap.py
index cca9470656f..22b93e2510f 100644
--- a/packages/python/plotly/plotly/graph_objs/_treemap.py
+++ b/packages/python/plotly/plotly/graph_objs/_treemap.py
@@ -66,7 +66,7 @@ def branchvalues(self):
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']
@@ -89,7 +89,7 @@ def count(self):
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
@@ -114,7 +114,7 @@ def customdata(self):
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
@@ -135,7 +135,7 @@ def customdatasrc(self):
"""
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
@@ -159,9 +159,9 @@ def domain(self):
- 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
@@ -194,7 +194,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -219,7 +219,7 @@ def hoverinfosrc(self):
"""
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
@@ -243,9 +243,9 @@ def hoverlabel(self):
- 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
@@ -318,7 +318,7 @@ def hovertemplate(self):
displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -341,7 +341,7 @@ def hovertemplatesrc(self):
"""
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
@@ -365,7 +365,7 @@ def hovertext(self):
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
@@ -388,7 +388,7 @@ def hovertextsrc(self):
"""
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
@@ -410,7 +410,7 @@ def ids(self):
Assigns id labels to 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
@@ -430,7 +430,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -450,17 +450,17 @@ def idssrc(self, val):
def insidetextfont(self):
"""
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 .
@@ -485,7 +485,7 @@ def insidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -506,7 +506,7 @@ def insidetextfont(self, val):
def labels(self):
"""
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
@@ -526,7 +526,7 @@ def labels(self, val):
def labelssrc(self):
"""
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
@@ -549,7 +549,7 @@ def level(self):
`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
@@ -572,9 +572,9 @@ def marker(self):
- 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
@@ -694,7 +694,7 @@ def maxdepth(self):
"""
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)
@@ -723,7 +723,7 @@ def meta(self):
access trace `meta` 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
@@ -742,7 +742,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -763,7 +763,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -784,7 +784,7 @@ def name(self, val):
def opacity(self):
"""
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]
@@ -808,17 +808,17 @@ def outsidetextfont(self):
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 .
@@ -843,7 +843,7 @@ def outsidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -869,7 +869,7 @@ def parents(self):
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
@@ -889,7 +889,7 @@ def parents(self, val):
def parentssrc(self):
"""
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
@@ -913,9 +913,9 @@ def pathbar(self):
- 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.
@@ -974,9 +974,9 @@ def stream(self):
- 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
@@ -1007,7 +1007,7 @@ def text(self):
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
@@ -1027,17 +1027,17 @@ def text(self, val):
def textfont(self):
"""
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 .
@@ -1062,7 +1062,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1083,7 +1083,7 @@ def textfont(self, val):
def textinfo(self):
"""
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
@@ -1106,7 +1106,7 @@ def textinfo(self, val):
def textposition(self):
"""
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',
@@ -1129,7 +1129,7 @@ def textposition(self, val):
def textsrc(self):
"""
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
@@ -1163,7 +1163,7 @@ def texttemplate(self):
are `arrayOk: true`) are available. 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
@@ -1186,7 +1186,7 @@ def texttemplatesrc(self):
"""
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
@@ -1210,9 +1210,9 @@ def tiling(self):
- 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.
@@ -1256,7 +1256,7 @@ def uid(self):
"""
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
@@ -1291,7 +1291,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1311,7 +1311,7 @@ def values(self):
"""
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
@@ -1331,7 +1331,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -1353,7 +1353,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1647,7 +1647,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_violin.py b/packages/python/plotly/plotly/graph_objs/_violin.py
index 991597cba5a..dafc4df316e 100644
--- a/packages/python/plotly/plotly/graph_objs/_violin.py
+++ b/packages/python/plotly/plotly/graph_objs/_violin.py
@@ -73,7 +73,7 @@ def alignmentgroup(self):
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
@@ -96,7 +96,7 @@ def bandwidth(self):
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]
@@ -120,9 +120,9 @@ def box(self):
- 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
@@ -155,7 +155,7 @@ def customdata(self):
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
@@ -176,7 +176,7 @@ def customdatasrc(self):
"""
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
@@ -198,7 +198,7 @@ def fillcolor(self):
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)')
@@ -259,7 +259,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -284,7 +284,7 @@ def hoverinfosrc(self):
"""
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
@@ -308,9 +308,9 @@ def hoverlabel(self):
- 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
@@ -365,7 +365,7 @@ def hoveron(self):
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
@@ -406,7 +406,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -429,7 +429,7 @@ def hovertemplatesrc(self):
"""
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
@@ -449,7 +449,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -472,7 +472,7 @@ def hovertextsrc(self):
"""
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
@@ -494,7 +494,7 @@ def ids(self):
Assigns id labels to 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
@@ -514,7 +514,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -537,7 +537,7 @@ def jitter(self):
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]
@@ -559,7 +559,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -584,9 +584,9 @@ def line(self):
- 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
@@ -613,9 +613,9 @@ def marker(self):
- 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:
-
+
color
Sets themarkercolor. It accepts either a
specific color or an array of numbers that are
@@ -659,9 +659,9 @@ def meanline(self):
- 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
@@ -699,7 +699,7 @@ def meta(self):
access trace `meta` 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
@@ -718,7 +718,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -744,7 +744,7 @@ def name(self):
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
@@ -767,7 +767,7 @@ def offsetgroup(self):
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
@@ -788,7 +788,7 @@ def offsetgroup(self, val):
def opacity(self):
"""
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]
@@ -809,7 +809,7 @@ def orientation(self):
"""
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']
@@ -834,7 +834,7 @@ def pointpos(self):
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]
@@ -861,7 +861,7 @@ def points(self):
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]
@@ -887,7 +887,7 @@ def scalegroup(self):
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
@@ -911,7 +911,7 @@ def scalemode(self):
determined."width" means each violin has the same (max)
width*count* means the violins are scaled by the number of
sample points makingup each violin.
-
+
The 'scalemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['width', 'count']
@@ -936,9 +936,9 @@ def selected(self):
- 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
@@ -965,7 +965,7 @@ def selectedpoints(self):
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
@@ -985,7 +985,7 @@ def showlegend(self):
"""
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)
@@ -1008,7 +1008,7 @@ def side(self):
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']
@@ -1028,19 +1028,19 @@ def side(self, val):
@property
def span(self):
"""
- 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
+ Sets the span in data space for which the density function will
+ be computed. Has an effect only when `spanmode` is set to
+ "manual".
- Returns
- -------
- list
+ 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
"""
return self["span"]
@@ -1060,7 +1060,7 @@ def spanmode(self):
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']
@@ -1085,9 +1085,9 @@ def stream(self):
- 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
@@ -1118,7 +1118,7 @@ def text(self):
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
@@ -1140,7 +1140,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1161,7 +1161,7 @@ def uid(self):
"""
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
@@ -1196,7 +1196,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1219,9 +1219,9 @@ def unselected(self):
- 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
@@ -1245,7 +1245,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1268,7 +1268,7 @@ def width(self):
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]
@@ -1289,7 +1289,7 @@ def x(self):
"""
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
@@ -1311,7 +1311,7 @@ def x0(self):
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
@@ -1333,7 +1333,7 @@ def xaxis(self):
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
@@ -1355,7 +1355,7 @@ def xaxis(self, val):
def xsrc(self):
"""
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
@@ -1376,7 +1376,7 @@ def y(self):
"""
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
@@ -1398,7 +1398,7 @@ def y0(self):
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
@@ -1420,7 +1420,7 @@ def yaxis(self):
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
@@ -1442,7 +1442,7 @@ def yaxis(self, val):
def ysrc(self):
"""
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
@@ -1797,7 +1797,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/_volume.py b/packages/python/plotly/plotly/graph_objs/_volume.py
index 0b0635e9a5d..1282c9fd27d 100644
--- a/packages/python/plotly/plotly/graph_objs/_volume.py
+++ b/packages/python/plotly/plotly/graph_objs/_volume.py
@@ -76,7 +76,7 @@ def autocolorscale(self):
`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)
@@ -100,9 +100,9 @@ def caps(self):
- 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
@@ -132,7 +132,7 @@ def cauto(self):
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)
@@ -153,7 +153,7 @@ def cmax(self):
"""
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
@@ -175,7 +175,7 @@ def cmid(self):
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
@@ -196,7 +196,7 @@ def cmin(self):
"""
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
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -247,9 +247,9 @@ def colorbar(self):
- 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
@@ -490,14 +490,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -537,9 +537,9 @@ def contour(self):
- 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
@@ -567,7 +567,7 @@ def customdata(self):
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
@@ -588,7 +588,7 @@ def customdatasrc(self):
"""
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
@@ -610,7 +610,7 @@ def flatshading(self):
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)
@@ -632,7 +632,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -657,7 +657,7 @@ def hoverinfosrc(self):
"""
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
@@ -681,9 +681,9 @@ def hoverlabel(self):
- 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
@@ -754,7 +754,7 @@ def hovertemplate(self):
contained in tag `` is displayed in the secondary box,
for example "{fullData.name}". To hide the
secondary box completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -777,7 +777,7 @@ def hovertemplatesrc(self):
"""
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
@@ -797,7 +797,7 @@ def hovertemplatesrc(self, val):
def hovertext(self):
"""
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
@@ -820,7 +820,7 @@ def hovertextsrc(self):
"""
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
@@ -842,7 +842,7 @@ def ids(self):
Assigns id labels to 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
@@ -862,7 +862,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -882,7 +882,7 @@ def idssrc(self, val):
def isomax(self):
"""
Sets the maximum boundary for iso-surface plot.
-
+
The 'isomax' property is a number and may be specified as:
- An int or float
@@ -902,7 +902,7 @@ def isomax(self, val):
def isomin(self):
"""
Sets the minimum boundary for iso-surface plot.
-
+
The 'isomin' property is a number and may be specified as:
- An int or float
@@ -924,7 +924,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -949,9 +949,9 @@ def lighting(self):
- 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.
@@ -997,9 +997,9 @@ def lightposition(self):
- 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.
@@ -1035,7 +1035,7 @@ def meta(self):
access trace `meta` 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
@@ -1054,7 +1054,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -1075,7 +1075,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1101,7 +1101,7 @@ def opacity(self):
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]
@@ -1129,7 +1129,7 @@ def opacityscale(self):
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
@@ -1150,7 +1150,7 @@ def reversescale(self):
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)
@@ -1173,7 +1173,7 @@ def scene(self):
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
@@ -1196,7 +1196,7 @@ def showlegend(self):
"""
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)
@@ -1217,7 +1217,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -1241,9 +1241,9 @@ def slices(self):
- 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
@@ -1274,9 +1274,9 @@ def spaceframe(self):
- 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
@@ -1309,9 +1309,9 @@ def stream(self):
- 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
@@ -1342,9 +1342,9 @@ def surface(self):
- 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
@@ -1390,7 +1390,7 @@ def text(self):
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
@@ -1412,7 +1412,7 @@ def text(self, val):
def textsrc(self):
"""
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
@@ -1433,7 +1433,7 @@ def uid(self):
"""
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
@@ -1468,7 +1468,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1487,7 +1487,7 @@ def uirevision(self, val):
def value(self):
"""
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
@@ -1507,7 +1507,7 @@ def value(self, val):
def valuesrc(self):
"""
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
@@ -1529,7 +1529,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1550,7 +1550,7 @@ def visible(self, val):
def x(self):
"""
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
@@ -1570,7 +1570,7 @@ def x(self, val):
def xsrc(self):
"""
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
@@ -1590,7 +1590,7 @@ def xsrc(self, val):
def y(self):
"""
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
@@ -1610,7 +1610,7 @@ def y(self, val):
def ysrc(self):
"""
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
@@ -1630,7 +1630,7 @@ def ysrc(self, val):
def z(self):
"""
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
@@ -1650,7 +1650,7 @@ def z(self, val):
def zsrc(self):
"""
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
@@ -1985,7 +1985,7 @@ def __init__(
):
"""
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-
diff --git a/packages/python/plotly/plotly/graph_objs/_waterfall.py b/packages/python/plotly/plotly/graph_objs/_waterfall.py
index 3e3df97d8af..869f4781ca2 100644
--- a/packages/python/plotly/plotly/graph_objs/_waterfall.py
+++ b/packages/python/plotly/plotly/graph_objs/_waterfall.py
@@ -86,7 +86,7 @@ def alignmentgroup(self):
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
@@ -107,7 +107,7 @@ def alignmentgroup(self, val):
def base(self):
"""
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
@@ -130,7 +130,7 @@ def cliponaxis(self):
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)
@@ -154,9 +154,9 @@ def connector(self):
- 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
@@ -183,7 +183,7 @@ def constraintext(self):
"""
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']
@@ -207,7 +207,7 @@ def customdata(self):
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
@@ -228,7 +228,7 @@ def customdatasrc(self):
"""
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
@@ -252,9 +252,9 @@ def decreasing(self):
- 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
@@ -276,7 +276,7 @@ def decreasing(self, val):
def dx(self):
"""
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
@@ -296,7 +296,7 @@ def dx(self, val):
def dy(self):
"""
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
@@ -318,7 +318,7 @@ def hoverinfo(self):
Determines which trace information appear on hover. 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
@@ -343,7 +343,7 @@ def hoverinfosrc(self):
"""
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
@@ -367,9 +367,9 @@ def hoverlabel(self):
- 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
@@ -441,7 +441,7 @@ def hovertemplate(self):
`` is displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -464,7 +464,7 @@ def hovertemplatesrc(self):
"""
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
@@ -488,7 +488,7 @@ def hovertext(self):
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
@@ -511,7 +511,7 @@ def hovertextsrc(self):
"""
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
@@ -533,7 +533,7 @@ def ids(self):
Assigns id labels to 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
@@ -553,7 +553,7 @@ def ids(self, val):
def idssrc(self):
"""
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
@@ -577,9 +577,9 @@ def increasing(self):
- 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
@@ -602,7 +602,7 @@ def insidetextanchor(self):
"""
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']
@@ -623,17 +623,17 @@ def insidetextanchor(self, val):
def insidetextfont(self):
"""
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 .
@@ -658,7 +658,7 @@ def insidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -681,7 +681,7 @@ def legendgroup(self):
Sets the legend group for this trace. Traces part of the same
legend group hide/show at the same time when toggling legend
items.
-
+
The 'legendgroup' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -706,7 +706,7 @@ def measure(self):
'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
@@ -726,7 +726,7 @@ def measure(self, val):
def measuresrc(self):
"""
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
@@ -755,7 +755,7 @@ def meta(self):
access trace `meta` 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
@@ -774,7 +774,7 @@ def meta(self, val):
def metasrc(self):
"""
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
@@ -795,7 +795,7 @@ def name(self):
"""
Sets the trace name. The trace name appear as the legend item
and on hover.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -818,7 +818,7 @@ def offset(self):
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
@@ -841,7 +841,7 @@ def offsetgroup(self):
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
@@ -862,7 +862,7 @@ def offsetgroup(self, val):
def offsetsrc(self):
"""
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
@@ -882,7 +882,7 @@ def offsetsrc(self, val):
def opacity(self):
"""
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]
@@ -903,7 +903,7 @@ def orientation(self):
"""
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']
@@ -924,17 +924,17 @@ def orientation(self, val):
def outsidetextfont(self):
"""
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 .
@@ -959,7 +959,7 @@ def outsidetextfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -985,7 +985,7 @@ def selectedpoints(self):
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
@@ -1005,7 +1005,7 @@ def showlegend(self):
"""
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)
@@ -1029,9 +1029,9 @@ def stream(self):
- 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
@@ -1063,7 +1063,7 @@ def text(self):
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
@@ -1088,7 +1088,7 @@ def textangle(self):
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
@@ -1110,17 +1110,17 @@ def textangle(self, val):
def textfont(self):
"""
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 .
@@ -1145,7 +1145,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -1168,7 +1168,7 @@ def textinfo(self):
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
@@ -1197,7 +1197,7 @@ def textposition(self):
then the text gets pushed inside. "auto" tries to position
`text` inside the bar, but if the bar is too small and no bar
is stacked on this one the text is moved outside.
-
+
The 'textposition' property is an enumeration that may be specified as:
- One of the following enumeration values:
['inside', 'outside', 'auto', 'none']
@@ -1220,7 +1220,7 @@ def textpositionsrc(self):
"""
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
@@ -1240,7 +1240,7 @@ def textpositionsrc(self, val):
def textsrc(self):
"""
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
@@ -1273,7 +1273,7 @@ def texttemplate(self):
Every attributes that can be specified per-point (the ones that
are `arrayOk: true`) are available. variables `initial`,
`delta`, `final` and `label`.
-
+
The 'texttemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1296,7 +1296,7 @@ def texttemplatesrc(self):
"""
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
@@ -1320,9 +1320,9 @@ def totals(self):
- 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
@@ -1345,7 +1345,7 @@ def uid(self):
"""
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
@@ -1380,7 +1380,7 @@ def uirevision(self):
`data` array, such that the same trace has 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
@@ -1401,7 +1401,7 @@ def visible(self):
Determines whether or not this 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']
@@ -1422,7 +1422,7 @@ def visible(self, val):
def width(self):
"""
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
@@ -1443,7 +1443,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -1463,7 +1463,7 @@ def widthsrc(self, val):
def x(self):
"""
Sets the x coordinates.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1485,7 +1485,7 @@ def x0(self):
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
@@ -1507,7 +1507,7 @@ def xaxis(self):
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
@@ -1596,7 +1596,7 @@ def xperiodalignment(self, val):
def xsrc(self):
"""
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
@@ -1616,7 +1616,7 @@ def xsrc(self, val):
def y(self):
"""
Sets the y coordinates.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1638,7 +1638,7 @@ def y0(self):
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
@@ -1660,7 +1660,7 @@ def yaxis(self):
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
@@ -1749,7 +1749,7 @@ def yperiodalignment(self, val):
def ysrc(self):
"""
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
@@ -2159,7 +2159,7 @@ def __init__(
):
"""
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
diff --git a/packages/python/plotly/plotly/graph_objs/area/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/area/_hoverlabel.py
index 771205196f4..c3d68a33aeb 100644
--- a/packages/python/plotly/plotly/graph_objs/area/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/area/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.area.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/area/_marker.py b/packages/python/plotly/plotly/graph_objs/area/_marker.py
index 88ac2610d6c..b683b088e50 100644
--- a/packages/python/plotly/plotly/graph_objs/area/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/area/_marker.py
@@ -29,7 +29,7 @@ def color(self):
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.
-
+
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)')
@@ -89,7 +89,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -110,7 +110,7 @@ def opacity(self):
"""
Area traces are deprecated! Please switch to the "barpolar"
trace type. Sets the marker opacity.
-
+
The 'opacity' 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
@@ -131,7 +131,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -152,7 +152,7 @@ def size(self):
"""
Area traces are deprecated! Please switch to the "barpolar"
trace type. Sets the marker size (in px).
-
+
The 'size' 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
@@ -173,7 +173,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -198,7 +198,7 @@ def symbol(self):
equivalent to appending "-dot" to a symbol name. Adding 300 is
equivalent to appending "-open-dot" or "dot-open" to a symbol
name.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -306,7 +306,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -374,7 +374,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/area/_stream.py b/packages/python/plotly/plotly/graph_objs/area/_stream.py
index 2a8e8846321..528cc9c2229 100644
--- a/packages/python/plotly/plotly/graph_objs/area/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/area/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/area/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/area/hoverlabel/_font.py
index dc29a473c8c..e9ee1a10e64 100644
--- a/packages/python/plotly/plotly/graph_objs/area/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/area/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_error_x.py b/packages/python/plotly/plotly/graph_objs/bar/_error_x.py
index 76831446ef5..b2bbb3b0d53 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_error_x.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_error_x.py
@@ -33,7 +33,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -55,7 +55,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -76,7 +76,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -116,7 +116,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -195,7 +195,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -215,7 +215,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -279,7 +279,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -302,7 +302,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -325,7 +325,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -345,7 +345,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -366,7 +366,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -464,7 +464,7 @@ def __init__(
):
"""
Construct a new ErrorX object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_error_y.py b/packages/python/plotly/plotly/graph_objs/bar/_error_y.py
index f19abcd4bc6..c3f439e6fbb 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_error_y.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_error_y.py
@@ -32,7 +32,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -54,7 +54,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -75,7 +75,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -95,7 +95,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -115,7 +115,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -176,7 +176,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -196,7 +196,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -260,7 +260,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -283,7 +283,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -306,7 +306,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -326,7 +326,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -347,7 +347,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -442,7 +442,7 @@ def __init__(
):
"""
Construct a new ErrorY object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/bar/_hoverlabel.py
index a4fa6ee1ddc..6431629a831 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.bar.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_insidetextfont.py b/packages/python/plotly/plotly/graph_objs/bar/_insidetextfont.py
index 968aeebf7f3..8de9e1323d9 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_insidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_insidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Insidetextfont object
-
+
Sets the font used for `text` lying inside the bar.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_marker.py b/packages/python/plotly/plotly/graph_objs/bar/_marker.py
index 0564145b845..19d88de2f82 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_marker.py
@@ -38,7 +38,7 @@ def autocolorscale(self):
or `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)
@@ -63,7 +63,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -86,7 +86,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -110,7 +110,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -133,7 +133,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -156,7 +156,7 @@ def color(self):
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.
-
+
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)')
@@ -223,7 +223,7 @@ def coloraxis(self):
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
@@ -249,9 +249,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.bar.marker.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
@@ -493,14 +493,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -536,7 +536,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -560,9 +560,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.bar.marker.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
@@ -668,7 +668,7 @@ def line(self, val):
def opacity(self):
"""
Sets the opacity of the bars.
-
+
The 'opacity' 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
@@ -689,7 +689,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -712,7 +712,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -734,7 +734,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -861,7 +861,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_outsidetextfont.py b/packages/python/plotly/plotly/graph_objs/bar/_outsidetextfont.py
index bdc4c4bc96a..80a4fc5c461 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_outsidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_outsidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Outsidetextfont object
-
+
Sets the font used for `text` lying outside the bar.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_selected.py b/packages/python/plotly/plotly/graph_objs/bar/_selected.py
index 8bcf151bc34..322d667bfbb 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.bar.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -48,9 +48,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.bar.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_stream.py b/packages/python/plotly/plotly/graph_objs/bar/_stream.py
index fd4e6f5bfc2..386335271b5 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_textfont.py b/packages/python/plotly/plotly/graph_objs/bar/_textfont.py
index 019b8e57194..02f6054438e 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used for `text`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/bar/_unselected.py b/packages/python/plotly/plotly/graph_objs/bar/_unselected.py
index cfa42899c92..ae9ef64aa22 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.bar.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.bar.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/_font.py
index 1396343c5ad..aced82889a4 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/bar/marker/_colorbar.py
index c207fc12096..f29af7cfad0 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.bar.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.bar.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -827,13 +827,13 @@ def tickformatstopdefaults(self):
When used in a template (as layout.template.data.bar.marker.col
orbar.tickformatstopdefaults), sets the default property values
to use for elements of bar.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -852,7 +852,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -878,7 +878,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -899,7 +899,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -922,7 +922,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -943,7 +943,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -966,7 +966,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -986,7 +986,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1007,7 +1007,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1027,7 +1027,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1047,7 +1047,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1071,9 +1071,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1108,17 +1108,17 @@ def titlefont(self):
Deprecated: Please use bar.marker.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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.bar.marker.colorbar.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
@@ -1140,7 +1140,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1157,14 +1157,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1178,7 +1178,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1200,7 +1200,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1221,7 +1221,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1241,7 +1241,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1263,7 +1263,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1284,7 +1284,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1553,7 +1553,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/_line.py b/packages/python/plotly/plotly/graph_objs/bar/marker/_line.py
index d3379ccb7a9..65cd8d4d24c 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickfont.py
index dbe2ecee189..233825af2f4 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py
index 267c7c96a77..187df845bdc 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_title.py
index d20cd873de8..d150e39c0ea 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.bar.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/_font.py
index 7b7d3c10013..57ed214de6d 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/bar/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/bar/selected/_marker.py
index 7891e4c4e50..00eda2f65b6 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/bar/selected/_textfont.py
index d23497ecb8d..2ddfdeec187 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/bar/unselected/_marker.py
index 981cc6ffb43..0882a16e501 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/bar/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/bar/unselected/_textfont.py
index 2a2dc43aa46..a910367748b 100644
--- a/packages/python/plotly/plotly/graph_objs/bar/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/bar/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/barpolar/_hoverlabel.py
index 1b6153fd5ec..7943260a511 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.barpolar.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/_marker.py b/packages/python/plotly/plotly/graph_objs/barpolar/_marker.py
index 45a03eaca54..a96f38753c6 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/_marker.py
@@ -38,7 +38,7 @@ def autocolorscale(self):
or `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)
@@ -63,7 +63,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -86,7 +86,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -110,7 +110,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -133,7 +133,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -156,7 +156,7 @@ def color(self):
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.
-
+
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)')
@@ -223,7 +223,7 @@ def coloraxis(self):
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
@@ -249,9 +249,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.barpolar.marker.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
@@ -494,14 +494,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -537,7 +537,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -561,9 +561,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.barpolar.marker.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
@@ -669,7 +669,7 @@ def line(self, val):
def opacity(self):
"""
Sets the opacity of the bars.
-
+
The 'opacity' 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
@@ -690,7 +690,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -713,7 +713,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -735,7 +735,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -862,7 +862,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/_selected.py b/packages/python/plotly/plotly/graph_objs/barpolar/_selected.py
index 1898c8c48d1..a077289566b 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.barpolar.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -48,9 +48,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.barpolar.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/_stream.py b/packages/python/plotly/plotly/graph_objs/barpolar/_stream.py
index 95e29f5f290..e2c63f966b3 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/_unselected.py b/packages/python/plotly/plotly/graph_objs/barpolar/_unselected.py
index 94eff828e09..f8e43f3b2b5 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.barpolar.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.barpolar.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/_font.py
index 9fdf8dc2edd..1c4fd20bdc8 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/_colorbar.py
index da62015e3e4..25b49b0847b 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
r.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
barpolar.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.barpolar.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/_line.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/_line.py
index bb3c1e63dfb..f3edd51af6c 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py
index a65c8dd3847..532c83efc39 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py
index 0587706106d..3f752a62d7a 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_title.py
index b4fd71feedb..80ea36a1786 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.barpolar.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py
index 62ee1cb9044..862003b5522 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/barpolar/selected/_marker.py
index 35bb6518812..168a2d9f264 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/barpolar/selected/_textfont.py
index 31bc8401bc7..e8d9904ad88 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_marker.py
index 78fec70e525..28a7ab9c9d2 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_textfont.py
index 64add409863..e7ad6554284 100644
--- a/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/barpolar/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/box/_hoverlabel.py
index ebe8d6e4415..fc9692d45b3 100644
--- a/packages/python/plotly/plotly/graph_objs/box/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/box/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.box.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/_line.py b/packages/python/plotly/plotly/graph_objs/box/_line.py
index 6bfba21e250..70f8e907994 100644
--- a/packages/python/plotly/plotly/graph_objs/box/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/box/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of line bounding the box(es).
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the width (in px) of line bounding the box(es).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/_marker.py b/packages/python/plotly/plotly/graph_objs/box/_marker.py
index aecbc947413..ac2c8aecf39 100644
--- a/packages/python/plotly/plotly/graph_objs/box/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/box/_marker.py
@@ -19,7 +19,7 @@ def color(self):
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.
-
+
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)')
@@ -82,9 +82,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.box.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets themarker.linecolor. It accepts either a
specific color or an array of numbers that are
@@ -118,7 +118,7 @@ def line(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -138,7 +138,7 @@ def opacity(self, val):
def outliercolor(self):
"""
Sets the color of the outlier sample points.
-
+
The 'outliercolor' 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)')
@@ -197,7 +197,7 @@ def outliercolor(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -220,7 +220,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -362,7 +362,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/_selected.py b/packages/python/plotly/plotly/graph_objs/box/_selected.py
index 43630bcc796..171a704cda2 100644
--- a/packages/python/plotly/plotly/graph_objs/box/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/box/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.box.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -53,7 +53,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/_stream.py b/packages/python/plotly/plotly/graph_objs/box/_stream.py
index cf3b8e271c5..f79b97ca59d 100644
--- a/packages/python/plotly/plotly/graph_objs/box/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/box/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/_unselected.py b/packages/python/plotly/plotly/graph_objs/box/_unselected.py
index 5b4250b4dba..5fc09a5050d 100644
--- a/packages/python/plotly/plotly/graph_objs/box/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/box/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.box.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -56,7 +56,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/box/hoverlabel/_font.py
index 29070fbe962..188d37c4079 100644
--- a/packages/python/plotly/plotly/graph_objs/box/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/box/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/box/marker/_line.py b/packages/python/plotly/plotly/graph_objs/box/marker/_line.py
index 8f6a2bb4b30..a6082abb23a 100644
--- a/packages/python/plotly/plotly/graph_objs/box/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/box/marker/_line.py
@@ -19,7 +19,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -79,7 +79,7 @@ def outliercolor(self):
"""
Sets the border line color of the outlier sample points.
Defaults to marker.color
-
+
The 'outliercolor' 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)')
@@ -139,7 +139,7 @@ def outlierwidth(self):
"""
Sets the border line width (in px) of the outlier sample
points.
-
+
The 'outlierwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -159,7 +159,7 @@ def outlierwidth(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -206,7 +206,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/box/selected/_marker.py
index a0fc73bab10..fac4999ec14 100644
--- a/packages/python/plotly/plotly/graph_objs/box/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/box/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/box/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/box/unselected/_marker.py
index 3f98df3ea77..d89fe7f8f12 100644
--- a/packages/python/plotly/plotly/graph_objs/box/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/box/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/_decreasing.py b/packages/python/plotly/plotly/graph_objs/candlestick/_decreasing.py
index 62882e4e7d0..8be11854970 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/_decreasing.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/_decreasing.py
@@ -18,7 +18,7 @@ def fillcolor(self):
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)')
@@ -81,9 +81,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.candlestick.decreasing.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
@@ -117,7 +117,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fillcolor=None, line=None, **kwargs):
"""
Construct a new Decreasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/candlestick/_hoverlabel.py
index b75a78a767b..7422526b86d 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/_hoverlabel.py
@@ -29,7 +29,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -51,7 +51,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -71,7 +71,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -131,7 +131,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -151,7 +151,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -212,7 +212,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -232,17 +232,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.candlestick.hoverlabel.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 .
@@ -267,7 +267,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -293,7 +293,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -316,7 +316,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -337,7 +337,7 @@ def split(self):
"""
Show hover information (open, close, high, low) in separate
labels.
-
+
The 'split' property must be specified as a bool
(either True, or False)
@@ -410,7 +410,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/_increasing.py b/packages/python/plotly/plotly/graph_objs/candlestick/_increasing.py
index dead60ecce4..9a9b03b8d0a 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/_increasing.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/_increasing.py
@@ -18,7 +18,7 @@ def fillcolor(self):
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)')
@@ -81,9 +81,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.candlestick.increasing.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
@@ -117,7 +117,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fillcolor=None, line=None, **kwargs):
"""
Construct a new Increasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/_line.py b/packages/python/plotly/plotly/graph_objs/candlestick/_line.py
index bbcaa63bf16..dcb9e5323cd 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/_line.py
@@ -18,7 +18,7 @@ def width(self):
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`.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -47,7 +47,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/_stream.py b/packages/python/plotly/plotly/graph_objs/candlestick/_stream.py
index 9e84269b0e5..09ae4efa745 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/_line.py b/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/_line.py
index a217a6791ca..8ce53074ac8 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/decreasing/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of line bounding the box(es).
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the width (in px) of line bounding the box(es).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/_font.py
index 7fff3847f4d..b3f3dd4eb4b 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/candlestick/increasing/_line.py b/packages/python/plotly/plotly/graph_objs/candlestick/increasing/_line.py
index bdf4b872b0d..4f2f607d2c2 100644
--- a/packages/python/plotly/plotly/graph_objs/candlestick/increasing/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/candlestick/increasing/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of line bounding the box(es).
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the width (in px) of line bounding the box(es).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/_aaxis.py b/packages/python/plotly/plotly/graph_objs/carpet/_aaxis.py
index f016348f9e0..ec33d926062 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/_aaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/_aaxis.py
@@ -73,7 +73,7 @@ class Aaxis(_BaseTraceHierarchyType):
def arraydtick(self):
"""
The stride between grid lines along the axis
-
+
The 'arraydtick' 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]
@@ -94,7 +94,7 @@ def arraydtick(self, val):
def arraytick0(self):
"""
The starting index of grid lines along the axis
-
+
The 'arraytick0' 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]
@@ -117,7 +117,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -140,7 +140,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -161,7 +161,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -191,7 +191,7 @@ def categoryorder(self):
for that attribute will be identical to the "trace" mode. The
unspecified categories will follow the categories in
`categoryarray`.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -235,7 +235,7 @@ def color(self):
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)')
@@ -294,7 +294,7 @@ def color(self, val):
def dtick(self):
"""
The stride between grid lines along the axis
-
+
The 'dtick' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -316,7 +316,7 @@ def endline(self):
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.
-
+
The 'endline' property must be specified as a bool
(either True, or False)
@@ -336,7 +336,7 @@ def endline(self, val):
def endlinecolor(self):
"""
Sets the line color of the end line.
-
+
The 'endlinecolor' 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)')
@@ -395,7 +395,7 @@ def endlinecolor(self, val):
def endlinewidth(self):
"""
Sets the width (in px) of the end line.
-
+
The 'endlinewidth' property is a number and may be specified as:
- An int or float
@@ -419,7 +419,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -441,7 +441,7 @@ def fixedrange(self):
"""
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
-
+
The 'fixedrange' property must be specified as a bool
(either True, or False)
@@ -461,7 +461,7 @@ def fixedrange(self, val):
def gridcolor(self):
"""
Sets the axis line color.
-
+
The 'gridcolor' 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)')
@@ -520,7 +520,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -540,7 +540,7 @@ def gridwidth(self, val):
def labelpadding(self):
"""
Extra padding between label and the axis
-
+
The 'labelpadding' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
@@ -560,7 +560,7 @@ def labelpadding(self, val):
def labelprefix(self):
"""
Sets a axis label prefix.
-
+
The 'labelprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -581,7 +581,7 @@ def labelprefix(self, val):
def labelsuffix(self):
"""
Sets a axis label suffix.
-
+
The 'labelsuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -602,7 +602,7 @@ def labelsuffix(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -661,7 +661,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -701,7 +701,7 @@ def minexponent(self, val):
def minorgridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'minorgridcolor' 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)')
@@ -760,7 +760,7 @@ def minorgridcolor(self, val):
def minorgridcount(self):
"""
Sets the number of minor grid ticks per major grid tick
-
+
The 'minorgridcount' 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]
@@ -781,7 +781,7 @@ def minorgridcount(self, val):
def minorgridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'minorgridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -804,7 +804,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -824,24 +824,24 @@ def nticks(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -858,7 +858,7 @@ def rangemode(self):
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.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['normal', 'tozero', 'nonnegative']
@@ -879,7 +879,7 @@ def rangemode(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -902,7 +902,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -924,7 +924,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -944,7 +944,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -965,7 +965,7 @@ def showticklabels(self):
"""
Determines whether axis labels are drawn on the low side, the
high side, both, or neither side of the axis.
-
+
The 'showticklabels' property is an enumeration that may be specified as:
- One of the following enumeration values:
['start', 'end', 'both', 'none']
@@ -989,7 +989,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1010,7 +1010,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1051,7 +1051,7 @@ def startline(self):
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.
-
+
The 'startline' property must be specified as a bool
(either True, or False)
@@ -1071,7 +1071,7 @@ def startline(self, val):
def startlinecolor(self):
"""
Sets the line color of the start line.
-
+
The 'startlinecolor' 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)')
@@ -1130,7 +1130,7 @@ def startlinecolor(self, val):
def startlinewidth(self):
"""
Sets the width (in px) of the start line.
-
+
The 'startlinewidth' property is a number and may be specified as:
- An int or float
@@ -1150,7 +1150,7 @@ def startlinewidth(self, val):
def tick0(self):
"""
The starting index of grid lines along the axis
-
+
The 'tick0' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1172,7 +1172,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -1194,17 +1194,17 @@ def tickangle(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.carpet.aaxis.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
@@ -1247,7 +1247,7 @@ def tickformat(self):
fractional seconds with n digits. For example, *2016-10-13
09:15:23.456* with tickformat "%H~%M~%S.%2f" would display
"09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1272,9 +1272,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.carpet.aaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1328,13 +1328,13 @@ def tickformatstopdefaults(self):
layout.template.data.carpet.aaxis.tickformatstopdefaults), sets
the default property values to use for elements of
carpet.aaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.carpet.aaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1372,7 +1372,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1393,7 +1393,7 @@ def tickprefix(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1416,7 +1416,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1436,7 +1436,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1457,7 +1457,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1477,7 +1477,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1501,9 +1501,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.carpet.aaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be set by the now
@@ -1538,17 +1538,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.carpet.aaxis.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
@@ -1570,7 +1570,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1587,13 +1587,13 @@ def titleoffset(self):
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.
-
+
The 'offset' property is a number and may be specified as:
- An int or float
Returns
-------
-
+
"""
return self["titleoffset"]
@@ -1609,7 +1609,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'date', 'category']
@@ -1897,7 +1897,7 @@ def __init__(
):
"""
Construct a new Aaxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/_baxis.py b/packages/python/plotly/plotly/graph_objs/carpet/_baxis.py
index 28d76ad8b6a..8ccac56a50e 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/_baxis.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/_baxis.py
@@ -73,7 +73,7 @@ class Baxis(_BaseTraceHierarchyType):
def arraydtick(self):
"""
The stride between grid lines along the axis
-
+
The 'arraydtick' 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]
@@ -94,7 +94,7 @@ def arraydtick(self, val):
def arraytick0(self):
"""
The starting index of grid lines along the axis
-
+
The 'arraytick0' 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]
@@ -117,7 +117,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -140,7 +140,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -161,7 +161,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -191,7 +191,7 @@ def categoryorder(self):
for that attribute will be identical to the "trace" mode. The
unspecified categories will follow the categories in
`categoryarray`.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -235,7 +235,7 @@ def color(self):
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)')
@@ -294,7 +294,7 @@ def color(self, val):
def dtick(self):
"""
The stride between grid lines along the axis
-
+
The 'dtick' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -316,7 +316,7 @@ def endline(self):
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.
-
+
The 'endline' property must be specified as a bool
(either True, or False)
@@ -336,7 +336,7 @@ def endline(self, val):
def endlinecolor(self):
"""
Sets the line color of the end line.
-
+
The 'endlinecolor' 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)')
@@ -395,7 +395,7 @@ def endlinecolor(self, val):
def endlinewidth(self):
"""
Sets the width (in px) of the end line.
-
+
The 'endlinewidth' property is a number and may be specified as:
- An int or float
@@ -419,7 +419,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -441,7 +441,7 @@ def fixedrange(self):
"""
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
-
+
The 'fixedrange' property must be specified as a bool
(either True, or False)
@@ -461,7 +461,7 @@ def fixedrange(self, val):
def gridcolor(self):
"""
Sets the axis line color.
-
+
The 'gridcolor' 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)')
@@ -520,7 +520,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -540,7 +540,7 @@ def gridwidth(self, val):
def labelpadding(self):
"""
Extra padding between label and the axis
-
+
The 'labelpadding' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
@@ -560,7 +560,7 @@ def labelpadding(self, val):
def labelprefix(self):
"""
Sets a axis label prefix.
-
+
The 'labelprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -581,7 +581,7 @@ def labelprefix(self, val):
def labelsuffix(self):
"""
Sets a axis label suffix.
-
+
The 'labelsuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -602,7 +602,7 @@ def labelsuffix(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -661,7 +661,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -701,7 +701,7 @@ def minexponent(self, val):
def minorgridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'minorgridcolor' 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)')
@@ -760,7 +760,7 @@ def minorgridcolor(self, val):
def minorgridcount(self):
"""
Sets the number of minor grid ticks per major grid tick
-
+
The 'minorgridcount' 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]
@@ -781,7 +781,7 @@ def minorgridcount(self, val):
def minorgridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'minorgridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -804,7 +804,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -824,24 +824,24 @@ def nticks(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -858,7 +858,7 @@ def rangemode(self):
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.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['normal', 'tozero', 'nonnegative']
@@ -879,7 +879,7 @@ def rangemode(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -902,7 +902,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -924,7 +924,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -944,7 +944,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -965,7 +965,7 @@ def showticklabels(self):
"""
Determines whether axis labels are drawn on the low side, the
high side, both, or neither side of the axis.
-
+
The 'showticklabels' property is an enumeration that may be specified as:
- One of the following enumeration values:
['start', 'end', 'both', 'none']
@@ -989,7 +989,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1010,7 +1010,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1051,7 +1051,7 @@ def startline(self):
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.
-
+
The 'startline' property must be specified as a bool
(either True, or False)
@@ -1071,7 +1071,7 @@ def startline(self, val):
def startlinecolor(self):
"""
Sets the line color of the start line.
-
+
The 'startlinecolor' 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)')
@@ -1130,7 +1130,7 @@ def startlinecolor(self, val):
def startlinewidth(self):
"""
Sets the width (in px) of the start line.
-
+
The 'startlinewidth' property is a number and may be specified as:
- An int or float
@@ -1150,7 +1150,7 @@ def startlinewidth(self, val):
def tick0(self):
"""
The starting index of grid lines along the axis
-
+
The 'tick0' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1172,7 +1172,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -1194,17 +1194,17 @@ def tickangle(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.carpet.baxis.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
@@ -1247,7 +1247,7 @@ def tickformat(self):
fractional seconds with n digits. For example, *2016-10-13
09:15:23.456* with tickformat "%H~%M~%S.%2f" would display
"09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1272,9 +1272,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.carpet.baxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1328,13 +1328,13 @@ def tickformatstopdefaults(self):
layout.template.data.carpet.baxis.tickformatstopdefaults), sets
the default property values to use for elements of
carpet.baxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.carpet.baxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1372,7 +1372,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1393,7 +1393,7 @@ def tickprefix(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1416,7 +1416,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1436,7 +1436,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1457,7 +1457,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1477,7 +1477,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1501,9 +1501,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.carpet.baxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be set by the now
@@ -1538,17 +1538,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.carpet.baxis.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
@@ -1570,7 +1570,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1587,13 +1587,13 @@ def titleoffset(self):
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.
-
+
The 'offset' property is a number and may be specified as:
- An int or float
Returns
-------
-
+
"""
return self["titleoffset"]
@@ -1609,7 +1609,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'date', 'category']
@@ -1897,7 +1897,7 @@ def __init__(
):
"""
Construct a new Baxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/_font.py b/packages/python/plotly/plotly/graph_objs/carpet/_font.py
index 7c47d7f7e13..89aad1f8264 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
The default font used for axis & tick labels on this carpet
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/_stream.py b/packages/python/plotly/plotly/graph_objs/carpet/_stream.py
index 9e49c78bcf8..a3748e6e156 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickfont.py
index 87815aadc1c..c63a3a5eb7c 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickformatstop.py
index dc5aba4b699..f8cbc5a9432 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_title.py b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_title.py
index 4a1e3e995f0..57272fcc356 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' title font. 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.carpet.aaxis.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
@@ -65,7 +65,7 @@ def offset(self):
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.
-
+
The 'offset' property is a number and may be specified as:
- An int or float
@@ -87,7 +87,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -126,7 +126,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/_font.py
index 431c85151d3..ce0bcac4167 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/aaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickfont.py
index 6adc18fba2d..b49d20b32c8 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickformatstop.py
index 14e90ae87ad..133de0fd1eb 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/baxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/baxis/_title.py b/packages/python/plotly/plotly/graph_objs/carpet/baxis/_title.py
index 3135c5bbf98..c1aecb7f129 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/baxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/baxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' title font. 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.carpet.baxis.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
@@ -65,7 +65,7 @@ def offset(self):
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.
-
+
The 'offset' property is a number and may be specified as:
- An int or float
@@ -87,7 +87,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -126,7 +126,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/_font.py
index 7d76db7cf08..f971b69ecd0 100644
--- a/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/carpet/baxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/_colorbar.py b/packages/python/plotly/plotly/graph_objs/choropleth/_colorbar.py
index 68b4a0a1219..cc63c58ff20 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.choropleth.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.choropleth.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -827,13 +827,13 @@ def tickformatstopdefaults(self):
When used in a template (as layout.template.data.choropleth.col
orbar.tickformatstopdefaults), sets the default property values
to use for elements of choropleth.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -852,7 +852,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -878,7 +878,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -899,7 +899,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -922,7 +922,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -943,7 +943,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -966,7 +966,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -986,7 +986,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1007,7 +1007,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1027,7 +1027,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1047,7 +1047,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1071,9 +1071,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.choropleth.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1108,17 +1108,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.choropleth.colorbar.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
@@ -1140,7 +1140,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1157,14 +1157,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1178,7 +1178,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1200,7 +1200,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1221,7 +1221,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1241,7 +1241,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1263,7 +1263,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1284,7 +1284,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1553,7 +1553,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/choropleth/_hoverlabel.py
index 30bb6fc4159..35892896130 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.choropleth.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/_marker.py b/packages/python/plotly/plotly/graph_objs/choropleth/_marker.py
index 55595689be5..b41e65297e6 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/_marker.py
@@ -20,9 +20,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.choropleth.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets themarker.linecolor. It accepts either a
specific color or an array of numbers that are
@@ -56,7 +56,7 @@ def line(self, val):
def opacity(self):
"""
Sets the opacity of the locations.
-
+
The 'opacity' 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
@@ -77,7 +77,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -109,7 +109,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/_selected.py b/packages/python/plotly/plotly/graph_objs/choropleth/_selected.py
index 2d8873117bf..f4496f728a9 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.choropleth.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
opacity
Sets the marker opacity of selected points.
@@ -49,7 +49,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/_stream.py b/packages/python/plotly/plotly/graph_objs/choropleth/_stream.py
index 596f32c42bf..b055e48aec0 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/_unselected.py b/packages/python/plotly/plotly/graph_objs/choropleth/_unselected.py
index 800f0be7380..13b92816635 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.choropleth.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
opacity
Sets the marker opacity of unselected points,
applied only when a selection exists.
@@ -50,7 +50,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickfont.py
index 4dfca01f083..41536f46f1e 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py
index e613e970c02..ad4881179b0 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_title.py
index d1447100835..6ad5025b2ec 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.choropleth.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/_font.py
index a111040a40c..1b2a16a554e 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/_font.py
index e36d088a07a..7ae61bb42e9 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/marker/_line.py b/packages/python/plotly/plotly/graph_objs/choropleth/marker/_line.py
index 039359ac9b3..5087e2c7e06 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/marker/_line.py
@@ -19,7 +19,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -79,7 +79,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -99,7 +99,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -120,7 +120,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -161,7 +161,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/choropleth/selected/_marker.py
index ed3117d66e2..14134d7264c 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choropleth/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/choropleth/unselected/_marker.py
index a5fd00657d1..99e04fb1987 100644
--- a/packages/python/plotly/plotly/graph_objs/choropleth/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/choropleth/unselected/_marker.py
@@ -17,7 +17,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -44,7 +44,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_colorbar.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_colorbar.py
index dc17271f221..3b2c8e36c85 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
ox.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
choroplethmapbox.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.choroplethmapbox.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1556,7 +1556,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_hoverlabel.py
index 199a9286b6e..4dcf2f30178 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.choroplethmapbox.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_marker.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_marker.py
index 5a0fedbc0fb..bdf5a141fec 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_marker.py
@@ -20,9 +20,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.choroplethmapbox.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets themarker.linecolor. It accepts either a
specific color or an array of numbers that are
@@ -56,7 +56,7 @@ def line(self, val):
def opacity(self):
"""
Sets the opacity of the locations.
-
+
The 'opacity' 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
@@ -77,7 +77,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -109,7 +109,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_selected.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_selected.py
index 901cafbe4d9..6534a301849 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.choroplethmapbox.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
opacity
Sets the marker opacity of selected points.
@@ -49,7 +49,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_stream.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_stream.py
index 072a3d7cfd6..04c29db7ca4 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_unselected.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_unselected.py
index 95c396d57a2..e41b4f60e44 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.choroplethmapbox.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
opacity
Sets the marker opacity of unselected points,
applied only when a selection exists.
@@ -50,7 +50,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py
index 15e1af7542d..f66ed3da488 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py
index a64f6c04bc8..2a9d590bdcc 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_title.py
index a762baa4be2..2cf1deb223f 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.choroplethmapbox.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py
index 34d823d6a45..44bdb12da7f 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py
index f7c59fc4ed7..72763572a7a 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/_line.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/_line.py
index b229ffed6a4..b60f6d76d2c 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/marker/_line.py
@@ -19,7 +19,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -79,7 +79,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -99,7 +99,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -120,7 +120,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -161,7 +161,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/_marker.py
index 6688c7912c5..170cd22eb00 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/_marker.py
index 059922106bf..e567ab0a4ca 100644
--- a/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/choroplethmapbox/unselected/_marker.py
@@ -17,7 +17,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -44,7 +44,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/_colorbar.py b/packages/python/plotly/plotly/graph_objs/cone/_colorbar.py
index a05e9276fac..e8d1223deb4 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.cone.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.cone.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
layout.template.data.cone.colorbar.tickformatstopdefaults),
sets the default property values to use for elements of
cone.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.cone.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.cone.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1109,17 +1109,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.cone.colorbar.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
@@ -1141,7 +1141,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1158,14 +1158,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1179,7 +1179,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1201,7 +1201,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1222,7 +1222,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1242,7 +1242,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1264,7 +1264,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1285,7 +1285,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1554,7 +1554,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/cone/_hoverlabel.py
index f45130a8180..20d88df7db2 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.cone.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/_lighting.py b/packages/python/plotly/plotly/graph_objs/cone/_lighting.py
index 2d6093bf247..91a4bfc83c6 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/_lighting.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/_lighting.py
@@ -25,7 +25,7 @@ def ambient(self):
"""
Ambient light increases overall color visibility but can wash
out the image.
-
+
The 'ambient' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -46,7 +46,7 @@ def diffuse(self):
"""
Represents the extent that incident rays are reflected in a
range of angles.
-
+
The 'diffuse' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -67,7 +67,7 @@ def facenormalsepsilon(self):
"""
Epsilon for face normals calculation avoids math issues arising
from degenerate geometry.
-
+
The 'facenormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -89,7 +89,7 @@ def fresnel(self):
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.
-
+
The 'fresnel' property is a number and may be specified as:
- An int or float in the interval [0, 5]
@@ -110,7 +110,7 @@ def roughness(self):
"""
Alters specular reflection; the rougher the surface, the wider
and less contrasty the shine.
-
+
The 'roughness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -131,7 +131,7 @@ def specular(self):
"""
Represents the level that incident rays are reflected in a
single direction, causing shine.
-
+
The 'specular' property is a number and may be specified as:
- An int or float in the interval [0, 2]
@@ -152,7 +152,7 @@ def vertexnormalsepsilon(self):
"""
Epsilon for vertex normals calculation avoids math issues
arising from degenerate geometry.
-
+
The 'vertexnormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -210,7 +210,7 @@ def __init__(
):
"""
Construct a new Lighting object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/_lightposition.py b/packages/python/plotly/plotly/graph_objs/cone/_lightposition.py
index 6e99108fa53..8d870fe76f7 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/_lightposition.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/_lightposition.py
@@ -16,7 +16,7 @@ class Lightposition(_BaseTraceHierarchyType):
def x(self):
"""
Numeric vector, representing the X coordinate for each vertex.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -36,7 +36,7 @@ def x(self, val):
def y(self):
"""
Numeric vector, representing the Y coordinate for each vertex.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -56,7 +56,7 @@ def y(self, val):
def z(self):
"""
Numeric vector, representing the Z coordinate for each vertex.
-
+
The 'z' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Lightposition object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/_stream.py b/packages/python/plotly/plotly/graph_objs/cone/_stream.py
index c0b99c080fa..93aeedd696d 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickfont.py
index de806d8545e..301c8ceddeb 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickformatstop.py
index dfcdd05e4a6..c781e6e2bc1 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/cone/colorbar/_title.py
index 0a0d30ec838..64604a4fe55 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.cone.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/_font.py
index 6c5959895bd..85ced494a81 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/_font.py
index 2c8d64e24b9..e41cfcfe7f9 100644
--- a/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/cone/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/contour/_colorbar.py b/packages/python/plotly/plotly/graph_objs/contour/_colorbar.py
index f98d91d74ee..72d79a15fd3 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.contour.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.contour.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
layout.template.data.contour.colorbar.tickformatstopdefaults),
sets the default property values to use for elements of
contour.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.contour.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.contour.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1109,17 +1109,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.contour.colorbar.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
@@ -1141,7 +1141,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1158,14 +1158,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1179,7 +1179,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1201,7 +1201,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1222,7 +1222,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1242,7 +1242,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1264,7 +1264,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1285,7 +1285,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1554,7 +1554,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contour/_contours.py b/packages/python/plotly/plotly/graph_objs/contour/_contours.py
index a4f62658dd9..ca840509543 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/_contours.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/_contours.py
@@ -32,7 +32,7 @@ def coloring(self):
"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.
-
+
The 'coloring' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fill', 'heatmap', 'lines', 'none']
@@ -54,7 +54,7 @@ def end(self):
"""
Sets the end contour level value. Must be more than
`contours.start`
-
+
The 'end' property is a number and may be specified as:
- An int or float
@@ -76,17 +76,17 @@ def labelfont(self):
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`.
-
+
The 'labelfont' property is an instance of Labelfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.contour.contours.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
@@ -125,7 +125,7 @@ def labelformat(self):
mini-language which is very similar to Python, see:
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'labelformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -153,7 +153,7 @@ def operation(self):
vs. closed intervals make no difference to constraint display,
but all versions are allowed for consistency with filter
transforms.
-
+
The 'operation' property is an enumeration that may be specified as:
- One of the following enumeration values:
['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][',
@@ -176,7 +176,7 @@ def showlabels(self):
"""
Determines whether to label the contour lines with their
values.
-
+
The 'showlabels' property must be specified as a bool
(either True, or False)
@@ -197,7 +197,7 @@ def showlines(self):
"""
Determines whether or not the contour lines are drawn. Has an
effect only if `contours.coloring` is set to "fill".
-
+
The 'showlines' property must be specified as a bool
(either True, or False)
@@ -217,7 +217,7 @@ def showlines(self, val):
def size(self):
"""
Sets the step between each contour level. Must be positive.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -238,7 +238,7 @@ def start(self):
"""
Sets the starting contour level value. Must be less than
`contours.end`
-
+
The 'start' property is a number and may be specified as:
- An int or float
@@ -261,7 +261,7 @@ def type(self):
multiple levels displayed. If `constraint`, the data is
represented as constraints with the invalid region shaded as
specified by the `operation` and `value` parameters.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['levels', 'constraint']
@@ -288,7 +288,7 @@ def value(self):
([],(),[),(],][,)(,](,)[) "value" is expected to be an array of
two numbers where the first is the lower bound and the second
is the upper bound.
-
+
The 'value' property accepts values of any type
Returns
@@ -381,7 +381,7 @@ def __init__(
):
"""
Construct a new Contours object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contour/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/contour/_hoverlabel.py
index f99aa52eb08..275a41fd55e 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.contour.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contour/_line.py b/packages/python/plotly/plotly/graph_objs/contour/_line.py
index f26beae0100..50fa9818f6a 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/_line.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the color of the contour level. Has no effect if
`contours.coloring` is set to "lines".
-
+
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)')
@@ -79,7 +79,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -103,7 +103,7 @@ def smoothing(self):
"""
Sets the amount of smoothing for the contour lines, where 0
corresponds to no smoothing.
-
+
The 'smoothing' property is a number and may be specified as:
- An int or float in the interval [0, 1.3]
@@ -125,7 +125,7 @@ def width(self):
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".
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -166,7 +166,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contour/_stream.py b/packages/python/plotly/plotly/graph_objs/contour/_stream.py
index 04de3fee68d..dc5c9972808 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickfont.py
index 600f96592f6..d7349c3dec3 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickformatstop.py
index 66626bce5e3..e6429d86076 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contour/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/contour/colorbar/_title.py
index 6e949202d07..c33169b9408 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.contour.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/_font.py
index 757c5f630a1..ce81634aac9 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/contour/contours/_labelfont.py b/packages/python/plotly/plotly/graph_objs/contour/contours/_labelfont.py
index fa0ded642a2..b489bdf9b45 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/contours/_labelfont.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/contours/_labelfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Labelfont object
-
+
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`.
diff --git a/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/_font.py
index 97c12986f4b..b90b8a8c925 100644
--- a/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/contour/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/_colorbar.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/_colorbar.py
index 082902bf586..e55397ba5c7 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.contourcarpet.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
contourcarpet.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.contourcarpet.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/_contours.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/_contours.py
index 18b68c0bc72..2cae61c29cb 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/_contours.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/_contours.py
@@ -31,7 +31,7 @@ def coloring(self):
"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.
-
+
The 'coloring' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fill', 'lines', 'none']
@@ -53,7 +53,7 @@ def end(self):
"""
Sets the end contour level value. Must be more than
`contours.start`
-
+
The 'end' property is a number and may be specified as:
- An int or float
@@ -75,17 +75,17 @@ def labelfont(self):
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`.
-
+
The 'labelfont' property is an instance of Labelfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.contourcarpet.contours.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
@@ -124,7 +124,7 @@ def labelformat(self):
mini-language which is very similar to Python, see:
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'labelformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -152,7 +152,7 @@ def operation(self):
vs. closed intervals make no difference to constraint display,
but all versions are allowed for consistency with filter
transforms.
-
+
The 'operation' property is an enumeration that may be specified as:
- One of the following enumeration values:
['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][',
@@ -175,7 +175,7 @@ def showlabels(self):
"""
Determines whether to label the contour lines with their
values.
-
+
The 'showlabels' property must be specified as a bool
(either True, or False)
@@ -196,7 +196,7 @@ def showlines(self):
"""
Determines whether or not the contour lines are drawn. Has an
effect only if `contours.coloring` is set to "fill".
-
+
The 'showlines' property must be specified as a bool
(either True, or False)
@@ -216,7 +216,7 @@ def showlines(self, val):
def size(self):
"""
Sets the step between each contour level. Must be positive.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -237,7 +237,7 @@ def start(self):
"""
Sets the starting contour level value. Must be less than
`contours.end`
-
+
The 'start' property is a number and may be specified as:
- An int or float
@@ -260,7 +260,7 @@ def type(self):
multiple levels displayed. If `constraint`, the data is
represented as constraints with the invalid region shaded as
specified by the `operation` and `value` parameters.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['levels', 'constraint']
@@ -287,7 +287,7 @@ def value(self):
([],(),[),(],][,)(,](,)[) "value" is expected to be an array of
two numbers where the first is the lower bound and the second
is the upper bound.
-
+
The 'value' property accepts values of any type
Returns
@@ -379,7 +379,7 @@ def __init__(
):
"""
Construct a new Contours object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/_line.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/_line.py
index b83444d8d92..31d7188ee3b 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/_line.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the color of the contour level. Has no effect if
`contours.coloring` is set to "lines".
-
+
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)')
@@ -79,7 +79,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -103,7 +103,7 @@ def smoothing(self):
"""
Sets the amount of smoothing for the contour lines, where 0
corresponds to no smoothing.
-
+
The 'smoothing' property is a number and may be specified as:
- An int or float in the interval [0, 1.3]
@@ -125,7 +125,7 @@ def width(self):
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".
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -166,7 +166,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/_stream.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/_stream.py
index af25a728274..ae34a2d03c5 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py
index c1173934dd7..ae948c11e2d 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py
index 719a5a4e94d..8cbb1b79e6e 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_title.py
index 1e7722fd1e5..ce7656f5687 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.contourcarpet.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/_font.py
index b04a0e7ee1c..bd29f5008fd 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/_labelfont.py b/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/_labelfont.py
index 004b976d97a..923e2654370 100644
--- a/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/_labelfont.py
+++ b/packages/python/plotly/plotly/graph_objs/contourcarpet/contours/_labelfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Labelfont object
-
+
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`.
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/_colorbar.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/_colorbar.py
index 16bd6d69ceb..f45534bd3c7 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.densitymapbox.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
densitymapbox.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.densitymapbox.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/_hoverlabel.py
index ea868b30ae8..b7cdb9fa2f6 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.densitymapbox.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/_stream.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/_stream.py
index d7350d28b21..52009fd11f4 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py
index 78ca15099d8..bdbace1ae4d 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py
index ade8bc8291b..ea1f7364714 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_title.py
index f6bd1fccfad..bbed76a2d62 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.densitymapbox.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/_font.py
index 918ae80c88b..b2da7f30928 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/_font.py
index b0a44fed539..bcc3ea70ce7 100644
--- a/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/densitymapbox/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/_connector.py b/packages/python/plotly/plotly/graph_objs/funnel/_connector.py
index 97665475611..b2edc04289e 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/_connector.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/_connector.py
@@ -16,7 +16,7 @@ class Connector(_BaseTraceHierarchyType):
def fillcolor(self):
"""
Sets the fill color.
-
+
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)')
@@ -79,9 +79,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.funnel.connector.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color.
dash
@@ -108,7 +108,7 @@ def line(self, val):
def visible(self):
"""
Determines if connector regions and lines are drawn.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -139,7 +139,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fillcolor=None, line=None, visible=None, **kwargs):
"""
Construct a new Connector object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/funnel/_hoverlabel.py
index df0b8d9fc60..c229be5ce16 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.funnel.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/_insidetextfont.py b/packages/python/plotly/plotly/graph_objs/funnel/_insidetextfont.py
index f9a77196dc8..21bca3f1927 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/_insidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/_insidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Insidetextfont object
-
+
Sets the font used for `text` lying inside the bar.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/_marker.py b/packages/python/plotly/plotly/graph_objs/funnel/_marker.py
index 15e41886f2d..aaa9cc9bbd1 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/_marker.py
@@ -38,7 +38,7 @@ def autocolorscale(self):
or `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)
@@ -63,7 +63,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -86,7 +86,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -110,7 +110,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -133,7 +133,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -156,7 +156,7 @@ def color(self):
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.
-
+
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)')
@@ -223,7 +223,7 @@ def coloraxis(self):
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
@@ -249,9 +249,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.funnel.marker.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
@@ -494,14 +494,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -537,7 +537,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -561,9 +561,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.funnel.marker.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
@@ -669,7 +669,7 @@ def line(self, val):
def opacity(self):
"""
Sets the opacity of the bars.
-
+
The 'opacity' 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
@@ -690,7 +690,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -713,7 +713,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -735,7 +735,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -862,7 +862,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/_outsidetextfont.py b/packages/python/plotly/plotly/graph_objs/funnel/_outsidetextfont.py
index 6424fb9d66e..c744b446b3d 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/_outsidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/_outsidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Outsidetextfont object
-
+
Sets the font used for `text` lying outside the bar.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/_stream.py b/packages/python/plotly/plotly/graph_objs/funnel/_stream.py
index f2265076cd2..cd58027af9a 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/_textfont.py b/packages/python/plotly/plotly/graph_objs/funnel/_textfont.py
index 6b7f7ae070f..d2f3f9bb94a 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used for `text`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/connector/_line.py b/packages/python/plotly/plotly/graph_objs/funnel/connector/_line.py
index 35144e2d1d7..916ff64d09a 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/connector/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/connector/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is a string and must be specified as:
- One of the following strings:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -101,7 +101,7 @@ def dash(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -134,7 +134,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/_font.py
index a119e5bb93e..e08cc035abe 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/_colorbar.py
index 8ed63b31c3a..6fa1f440448 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.funnel.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
funnel.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.funnel.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/_line.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/_line.py
index 12521dea1ef..ddafc9b5227 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py
index 6db7a30a2fb..93f2952acae 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py
index 81ac1335f36..6706d60ff7e 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_title.py
index aac0cc788d0..1273e17740f 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.funnel.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/_font.py
index d61481785cc..13ff183ea73 100644
--- a/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/funnel/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/_domain.py b/packages/python/plotly/plotly/graph_objs/funnelarea/_domain.py
index 415ca8f1523..8633b8f5e28 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this funnelarea trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this funnelarea trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this funnelarea trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this funnelarea trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this funnelarea trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this funnelarea trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/funnelarea/_hoverlabel.py
index f772de10c18..d92f157c099 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.funnelarea.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/_insidetextfont.py b/packages/python/plotly/plotly/graph_objs/funnelarea/_insidetextfont.py
index a01f66134fc..9c8f226f34b 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/_insidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/_insidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Insidetextfont object
-
+
Sets the font used for `textinfo` lying inside the sector.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/_marker.py b/packages/python/plotly/plotly/graph_objs/funnelarea/_marker.py
index 18495637fb7..3f698b9f0ba 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/_marker.py
@@ -17,7 +17,7 @@ def colors(self):
"""
Sets the color of each sector. If not specified, the default
trace color set is used to pick the sector colors.
-
+
The 'colors' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -37,7 +37,7 @@ def colors(self, val):
def colorssrc(self):
"""
Sets the source reference on Chart Studio Cloud for colors .
-
+
The 'colorssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -61,9 +61,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.funnelarea.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the line enclosing each
sector. Defaults to the `paper_bgcolor` value.
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/_stream.py b/packages/python/plotly/plotly/graph_objs/funnelarea/_stream.py
index 3c23716e72a..0bff7d552fd 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/_textfont.py b/packages/python/plotly/plotly/graph_objs/funnelarea/_textfont.py
index c9af64f7948..0b7d232fc9f 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used for `textinfo`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/_title.py b/packages/python/plotly/plotly/graph_objs/funnelarea/_title.py
index 8f637217ae8..7ff045a2151 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
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.funnelarea.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 .
@@ -52,7 +52,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -75,7 +75,7 @@ def position(self):
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']
@@ -99,7 +99,7 @@ def text(self):
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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -138,7 +138,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, position=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/_font.py
index 6974d545a1a..44330fbb1dc 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/marker/_line.py b/packages/python/plotly/plotly/graph_objs/funnelarea/marker/_line.py
index 3749d482011..4a1ec824ca8 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/marker/_line.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the color of the line enclosing each sector. Defaults to
the `paper_bgcolor` value.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the line enclosing each sector.
-
+
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
@@ -118,7 +118,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -156,7 +156,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/funnelarea/title/_font.py b/packages/python/plotly/plotly/graph_objs/funnelarea/title/_font.py
index 3f118e9c25e..a5fcbdf1811 100644
--- a/packages/python/plotly/plotly/graph_objs/funnelarea/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/funnelarea/title/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used for `title`. Note that the title's font used
to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/_colorbar.py b/packages/python/plotly/plotly/graph_objs/heatmap/_colorbar.py
index e6b6bf28609..a8589d7e33b 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmap.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.heatmap.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
layout.template.data.heatmap.colorbar.tickformatstopdefaults),
sets the default property values to use for elements of
heatmap.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.heatmap.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1109,17 +1109,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmap.colorbar.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
@@ -1141,7 +1141,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1158,14 +1158,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1179,7 +1179,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1201,7 +1201,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1222,7 +1222,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1242,7 +1242,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1264,7 +1264,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1285,7 +1285,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1554,7 +1554,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/heatmap/_hoverlabel.py
index 822d43f5a74..9c8704094b0 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmap.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/_stream.py b/packages/python/plotly/plotly/graph_objs/heatmap/_stream.py
index 8616a42b938..4a45b74c82c 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickfont.py
index 3902a7bdd3f..31dcd3aca27 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py
index 0386985848e..861eb5b1936 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_title.py
index 01838665296..d9b82e412e7 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.heatmap.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/_font.py
index 9bad68276a2..2f937597897 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/_font.py
index 5f2b513b017..2a0e36f5404 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmap/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/_colorbar.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/_colorbar.py
index 1ca7f8fcf9f..3a24e0d1b28 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.heatmapgl.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -827,13 +827,13 @@ def tickformatstopdefaults(self):
When used in a template (as layout.template.data.heatmapgl.colo
rbar.tickformatstopdefaults), sets the default property values
to use for elements of heatmapgl.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -852,7 +852,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -878,7 +878,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -899,7 +899,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -922,7 +922,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -943,7 +943,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -966,7 +966,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -986,7 +986,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1007,7 +1007,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1027,7 +1027,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1047,7 +1047,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1071,9 +1071,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1108,17 +1108,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmapgl.colorbar.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
@@ -1140,7 +1140,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1157,14 +1157,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1178,7 +1178,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1200,7 +1200,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1221,7 +1221,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1241,7 +1241,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1263,7 +1263,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1284,7 +1284,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1553,7 +1553,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/_hoverlabel.py
index 1104c4f8cad..7c864ad3cc2 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.heatmapgl.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/_stream.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/_stream.py
index afae4f74473..0253ffd4cd2 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickfont.py
index 7477b035768..33f69bdd945 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py
index a73137263a4..f41f2adc8ad 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_title.py
index 1e7c7d4e2d5..ca5063fd08a 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.heatmapgl.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/_font.py
index 1e9dd87d628..79923a1bc28 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/_font.py
index fa1415524fb..ff615784cca 100644
--- a/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/heatmapgl/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_cumulative.py b/packages/python/plotly/plotly/graph_objs/histogram/_cumulative.py
index 12e12019fa7..ae90b46c5d5 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_cumulative.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_cumulative.py
@@ -21,7 +21,7 @@ def currentbin(self):
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.
-
+
The 'currentbin' property is an enumeration that may be specified as:
- One of the following enumeration values:
['include', 'exclude', 'half']
@@ -45,7 +45,7 @@ def direction(self):
(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.
-
+
The 'direction' property is an enumeration that may be specified as:
- One of the following enumeration values:
['increasing', 'decreasing']
@@ -72,7 +72,7 @@ def enabled(self):
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.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -120,7 +120,7 @@ def __init__(
):
"""
Construct a new Cumulative object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_error_x.py b/packages/python/plotly/plotly/graph_objs/histogram/_error_x.py
index f2f56bb3f99..479be31594a 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_error_x.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_error_x.py
@@ -33,7 +33,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -55,7 +55,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -76,7 +76,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -116,7 +116,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -195,7 +195,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -215,7 +215,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -279,7 +279,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -302,7 +302,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -325,7 +325,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -345,7 +345,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -366,7 +366,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -464,7 +464,7 @@ def __init__(
):
"""
Construct a new ErrorX object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_error_y.py b/packages/python/plotly/plotly/graph_objs/histogram/_error_y.py
index 106a3cc442e..99fbe0295c6 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_error_y.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_error_y.py
@@ -32,7 +32,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -54,7 +54,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -75,7 +75,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -95,7 +95,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -115,7 +115,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -176,7 +176,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -196,7 +196,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -260,7 +260,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -283,7 +283,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -306,7 +306,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -326,7 +326,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -347,7 +347,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -442,7 +442,7 @@ def __init__(
):
"""
Construct a new ErrorY object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/histogram/_hoverlabel.py
index 9fa2b684fee..4b9982cc384 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_marker.py b/packages/python/plotly/plotly/graph_objs/histogram/_marker.py
index 73248c154e5..d2ae72383f1 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_marker.py
@@ -38,7 +38,7 @@ def autocolorscale(self):
or `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)
@@ -63,7 +63,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -86,7 +86,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -110,7 +110,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -133,7 +133,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -156,7 +156,7 @@ def color(self):
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.
-
+
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)')
@@ -223,7 +223,7 @@ def coloraxis(self):
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
@@ -249,9 +249,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.histogram.marker.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
@@ -494,14 +494,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -537,7 +537,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -561,9 +561,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.histogram.marker.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
@@ -669,7 +669,7 @@ def line(self, val):
def opacity(self):
"""
Sets the opacity of the bars.
-
+
The 'opacity' 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
@@ -690,7 +690,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -713,7 +713,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -735,7 +735,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -862,7 +862,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_selected.py b/packages/python/plotly/plotly/graph_objs/histogram/_selected.py
index 76e0a6f1f91..3f5e60fd2aa 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.histogram.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -48,9 +48,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.histogram.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_stream.py b/packages/python/plotly/plotly/graph_objs/histogram/_stream.py
index b2e20f05ba2..1b85fe5af19 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_unselected.py b/packages/python/plotly/plotly/graph_objs/histogram/_unselected.py
index 1206780b661..471b0cf606a 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.histogram.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.histogram.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_xbins.py b/packages/python/plotly/plotly/graph_objs/histogram/_xbins.py
index 2d052176311..7fcc9584e1c 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_xbins.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_xbins.py
@@ -21,7 +21,7 @@ def end(self):
maximum data value. Like `start`, for dates use a date string,
and for category data `end` is based on the category serial
numbers.
-
+
The 'end' property accepts values of any type
Returns
@@ -51,7 +51,7 @@ def size(self):
and all others discarded. If no `size` is provided,the sample
data from all traces is combined to determine `size` as
described above.
-
+
The 'size' property accepts values of any type
Returns
@@ -82,7 +82,7 @@ def start(self):
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.
-
+
The 'start' property accepts values of any type
Returns
@@ -142,7 +142,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
"""
Construct a new XBins object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/_ybins.py b/packages/python/plotly/plotly/graph_objs/histogram/_ybins.py
index 3a4d4050ae1..3f3e479774a 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/_ybins.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/_ybins.py
@@ -21,7 +21,7 @@ def end(self):
maximum data value. Like `start`, for dates use a date string,
and for category data `end` is based on the category serial
numbers.
-
+
The 'end' property accepts values of any type
Returns
@@ -51,7 +51,7 @@ def size(self):
and all others discarded. If no `size` is provided,the sample
data from all traces is combined to determine `size` as
described above.
-
+
The 'size' property accepts values of any type
Returns
@@ -82,7 +82,7 @@ def start(self):
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.
-
+
The 'start' property accepts values of any type
Returns
@@ -142,7 +142,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
"""
Construct a new YBins object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/_font.py
index 8461ea43c65..bfa827582f9 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/_colorbar.py
index 0e017951828..ae259902efb 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.histogram.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
er.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
histogram.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.histogram.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1556,7 +1556,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/_line.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/_line.py
index 3442e109378..93d28353ca0 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py
index 58a0ee3c1ec..f0a2f04cbcc 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py
index bc3c20c0e37..5598a5e1dee 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_title.py
index 8604c95133b..d512fafa6c5 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.histogram.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/_font.py
index 9d05fcff19d..5c04dc5102f 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/histogram/selected/_marker.py
index cf097541cf9..ca40612946b 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/histogram/selected/_textfont.py
index 34c475eed70..08026890731 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/histogram/unselected/_marker.py
index d098fe7685d..f303fe4af83 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/histogram/unselected/_textfont.py
index 64b334c8a0f..1be47c389f1 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/_colorbar.py b/packages/python/plotly/plotly/graph_objs/histogram2d/_colorbar.py
index c6351bfb09d..23ae1c0afbb 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2d.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.histogram2d.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
lorbar.tickformatstopdefaults), sets the default property
values to use for elements of
histogram2d.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1109,17 +1109,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2d.colorbar.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
@@ -1141,7 +1141,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1158,14 +1158,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1179,7 +1179,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1201,7 +1201,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1222,7 +1222,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1242,7 +1242,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1264,7 +1264,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1285,7 +1285,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1554,7 +1554,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/histogram2d/_hoverlabel.py
index 065ff883693..9ae0c8b30b1 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2d.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/_marker.py b/packages/python/plotly/plotly/graph_objs/histogram2d/_marker.py
index 803132d41ff..f0d78750255 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the aggregation data.
-
+
The 'color' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -36,7 +36,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -65,7 +65,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, colorsrc=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/_stream.py b/packages/python/plotly/plotly/graph_objs/histogram2d/_stream.py
index 15091d1de5b..8daf6beff30 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/_xbins.py b/packages/python/plotly/plotly/graph_objs/histogram2d/_xbins.py
index 5ce6e0ef91c..a2944f5166e 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/_xbins.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/_xbins.py
@@ -21,7 +21,7 @@ def end(self):
maximum data value. Like `start`, for dates use a date string,
and for category data `end` is based on the category serial
numbers.
-
+
The 'end' property accepts values of any type
Returns
@@ -47,7 +47,7 @@ def size(self):
data, use milliseconds or "M" for months, as in
`axis.dtick`. For category data, the number of categories to
bin together (always defaults to 1).
-
+
The 'size' property accepts values of any type
Returns
@@ -75,7 +75,7 @@ def start(self):
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.
-
+
The 'start' property accepts values of any type
Returns
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
"""
Construct a new XBins object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/_ybins.py b/packages/python/plotly/plotly/graph_objs/histogram2d/_ybins.py
index 3aec4faaa3b..59b0a5ba590 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/_ybins.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/_ybins.py
@@ -21,7 +21,7 @@ def end(self):
maximum data value. Like `start`, for dates use a date string,
and for category data `end` is based on the category serial
numbers.
-
+
The 'end' property accepts values of any type
Returns
@@ -47,7 +47,7 @@ def size(self):
data, use milliseconds or "M" for months, as in
`axis.dtick`. For category data, the number of categories to
bin together (always defaults to 1).
-
+
The 'size' property accepts values of any type
Returns
@@ -75,7 +75,7 @@ def start(self):
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.
-
+
The 'start' property accepts values of any type
Returns
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
"""
Construct a new YBins object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickfont.py
index ff3a211b3b1..d74b8be7509 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py
index 2d42973b4de..672d939c2b1 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_title.py
index 04af9f39746..3a255504a28 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.histogram2d.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/_font.py
index 16522db9814..c3de2e91b4e 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/_font.py
index daa09b9a102..9f83c19904c 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2d/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_colorbar.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_colorbar.py
index d3f11d6217b..a6d85ae16bd 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
tour.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
histogram2dcontour.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.histogram2dcontour.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1557,7 +1557,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_contours.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_contours.py
index a01ad5dd0ed..799247bca22 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_contours.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_contours.py
@@ -32,7 +32,7 @@ def coloring(self):
"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.
-
+
The 'coloring' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fill', 'heatmap', 'lines', 'none']
@@ -54,7 +54,7 @@ def end(self):
"""
Sets the end contour level value. Must be more than
`contours.start`
-
+
The 'end' property is a number and may be specified as:
- An int or float
@@ -76,17 +76,17 @@ def labelfont(self):
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`.
-
+
The 'labelfont' property is an instance of Labelfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2dcontour.contours.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
@@ -125,7 +125,7 @@ def labelformat(self):
mini-language which is very similar to Python, see:
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'labelformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -153,7 +153,7 @@ def operation(self):
vs. closed intervals make no difference to constraint display,
but all versions are allowed for consistency with filter
transforms.
-
+
The 'operation' property is an enumeration that may be specified as:
- One of the following enumeration values:
['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][',
@@ -176,7 +176,7 @@ def showlabels(self):
"""
Determines whether to label the contour lines with their
values.
-
+
The 'showlabels' property must be specified as a bool
(either True, or False)
@@ -197,7 +197,7 @@ def showlines(self):
"""
Determines whether or not the contour lines are drawn. Has an
effect only if `contours.coloring` is set to "fill".
-
+
The 'showlines' property must be specified as a bool
(either True, or False)
@@ -217,7 +217,7 @@ def showlines(self, val):
def size(self):
"""
Sets the step between each contour level. Must be positive.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -238,7 +238,7 @@ def start(self):
"""
Sets the starting contour level value. Must be less than
`contours.end`
-
+
The 'start' property is a number and may be specified as:
- An int or float
@@ -261,7 +261,7 @@ def type(self):
multiple levels displayed. If `constraint`, the data is
represented as constraints with the invalid region shaded as
specified by the `operation` and `value` parameters.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['levels', 'constraint']
@@ -288,7 +288,7 @@ def value(self):
([],(),[),(],][,)(,](,)[) "value" is expected to be an array of
two numbers where the first is the lower bound and the second
is the upper bound.
-
+
The 'value' property accepts values of any type
Returns
@@ -381,7 +381,7 @@ def __init__(
):
"""
Construct a new Contours object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_hoverlabel.py
index c4c880f1087..e96c70eab41 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.histogram2dcontour.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_line.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_line.py
index f3f9e9c81c6..548930379e4 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_line.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the color of the contour level. Has no effect if
`contours.coloring` is set to "lines".
-
+
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)')
@@ -79,7 +79,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -103,7 +103,7 @@ def smoothing(self):
"""
Sets the amount of smoothing for the contour lines, where 0
corresponds to no smoothing.
-
+
The 'smoothing' property is a number and may be specified as:
- An int or float in the interval [0, 1.3]
@@ -123,7 +123,7 @@ def smoothing(self, val):
def width(self):
"""
Sets the contour line width in (in px)
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -162,7 +162,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_marker.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_marker.py
index 180e12b631b..51318fb28ff 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the aggregation data.
-
+
The 'color' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -36,7 +36,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -65,7 +65,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, colorsrc=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_stream.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_stream.py
index e0f0f61218e..b7b1f5decec 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_xbins.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_xbins.py
index 715ce55c069..51c591717a2 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_xbins.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_xbins.py
@@ -21,7 +21,7 @@ def end(self):
maximum data value. Like `start`, for dates use a date string,
and for category data `end` is based on the category serial
numbers.
-
+
The 'end' property accepts values of any type
Returns
@@ -47,7 +47,7 @@ def size(self):
data, use milliseconds or "M" for months, as in
`axis.dtick`. For category data, the number of categories to
bin together (always defaults to 1).
-
+
The 'size' property accepts values of any type
Returns
@@ -75,7 +75,7 @@ def start(self):
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.
-
+
The 'start' property accepts values of any type
Returns
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
"""
Construct a new XBins object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_ybins.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_ybins.py
index e81ca41c13a..19474dadec7 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_ybins.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/_ybins.py
@@ -21,7 +21,7 @@ def end(self):
maximum data value. Like `start`, for dates use a date string,
and for category data `end` is based on the category serial
numbers.
-
+
The 'end' property accepts values of any type
Returns
@@ -47,7 +47,7 @@ def size(self):
data, use milliseconds or "M" for months, as in
`axis.dtick`. For category data, the number of categories to
bin together (always defaults to 1).
-
+
The 'size' property accepts values of any type
Returns
@@ -75,7 +75,7 @@ def start(self):
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.
-
+
The 'start' property accepts values of any type
Returns
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, end=None, size=None, start=None, **kwargs):
"""
Construct a new YBins object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py
index 64cfb734c99..cf418ee2dda 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py
index 4958b60d7c9..04e1da5cb9e 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_title.py
index de48d3e7988..a3209d1f0a1 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.histogram2dcontour.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py
index a2fd6065e31..ee9a8833828 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py
index 4c01381bf3d..dabc3d0ece7 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Labelfont object
-
+
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`.
diff --git a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py
index d51428fe6ad..6153d77ccb3 100644
--- a/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/image/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/image/_hoverlabel.py
index 60e67c1726d..6047664afc1 100644
--- a/packages/python/plotly/plotly/graph_objs/image/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/image/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.image.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/image/_stream.py b/packages/python/plotly/plotly/graph_objs/image/_stream.py
index 36e8ad44b5c..c3f97530f2f 100644
--- a/packages/python/plotly/plotly/graph_objs/image/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/image/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/image/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/image/hoverlabel/_font.py
index eee8996e010..130065123bb 100644
--- a/packages/python/plotly/plotly/graph_objs/image/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/image/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/_delta.py b/packages/python/plotly/plotly/graph_objs/indicator/_delta.py
index c2753b2210b..89eec573b46 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/_delta.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/_delta.py
@@ -28,9 +28,9 @@ def decreasing(self):
- An instance of :class:`plotly.graph_objs.indicator.delta.Decreasing`
- A dict of string/value properties that will be passed
to the Decreasing constructor
-
+
Supported dict properties:
-
+
color
Sets the color for increasing value.
symbol
@@ -52,17 +52,17 @@ def decreasing(self, val):
def font(self):
"""
Set the font used to display the delta
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.delta.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
@@ -102,9 +102,9 @@ def increasing(self):
- An instance of :class:`plotly.graph_objs.indicator.delta.Increasing`
- A dict of string/value properties that will be passed
to the Increasing constructor
-
+
Supported dict properties:
-
+
color
Sets the color for increasing value.
symbol
@@ -126,7 +126,7 @@ def increasing(self, val):
def position(self):
"""
Sets the position of delta with respect to the number.
-
+
The 'position' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right']
@@ -148,7 +148,7 @@ def reference(self):
"""
Sets the reference value to compute the delta. By default, it
is set to the current value.
-
+
The 'reference' property is a number and may be specified as:
- An int or float
@@ -168,7 +168,7 @@ def reference(self, val):
def relative(self):
"""
Show relative change
-
+
The 'relative' property must be specified as a bool
(either True, or False)
@@ -191,7 +191,7 @@ def valueformat(self):
language which is similar to those of Python. See
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'valueformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -247,7 +247,7 @@ def __init__(
):
"""
Construct a new Delta object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/_domain.py b/packages/python/plotly/plotly/graph_objs/indicator/_domain.py
index 44c7d85c846..9634fccaf20 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this indicator trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this indicator trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this indicator trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this indicator trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this indicator trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this indicator trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/_gauge.py b/packages/python/plotly/plotly/graph_objs/indicator/_gauge.py
index ad977448293..59f974797cf 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/_gauge.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/_gauge.py
@@ -30,9 +30,9 @@ def axis(self):
- An instance of :class:`plotly.graph_objs.indicator.gauge.Axis`
- A dict of string/value properties that will be passed
to the Axis constructor
-
+
Supported dict properties:
-
+
dtick
Sets the step in-between ticks on this axis.
Use with `tick0`. Must be a positive number, or
@@ -203,15 +203,15 @@ def axis(self, val):
def bar(self):
"""
Set the appearance of the gauge's value
-
+
The 'bar' property is an instance of Bar
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.gauge.Bar`
- A dict of string/value properties that will be passed
to the Bar constructor
-
+
Supported dict properties:
-
+
color
Sets the background color of the arc.
line
@@ -238,7 +238,7 @@ def bar(self, val):
def bgcolor(self):
"""
Sets the gauge background color.
-
+
The '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)')
@@ -297,7 +297,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the color of the border enclosing the gauge.
-
+
The 'bordercolor' 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)')
@@ -356,7 +356,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) of the border enclosing the gauge.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -376,7 +376,7 @@ def borderwidth(self, val):
def shape(self):
"""
Set the shape of the gauge
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['angular', 'bullet']
@@ -401,9 +401,9 @@ def steps(self):
- A list or tuple of instances of plotly.graph_objs.indicator.gauge.Step
- A list or tuple of dicts of string/value properties that
will be passed to the Step constructor
-
+
Supported dict properties:
-
+
color
Sets the background color of the arc.
line
@@ -456,13 +456,13 @@ def stepdefaults(self):
layout.template.data.indicator.gauge.stepdefaults), sets the
default property values to use for elements of
indicator.gauge.steps
-
+
The 'stepdefaults' property is an instance of Step
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.gauge.Step`
- A dict of string/value properties that will be passed
to the Step constructor
-
+
Supported dict properties:
Returns
@@ -485,9 +485,9 @@ def threshold(self):
- An instance of :class:`plotly.graph_objs.indicator.gauge.Threshold`
- A dict of string/value properties that will be passed
to the Threshold constructor
-
+
Supported dict properties:
-
+
line
:class:`plotly.graph_objects.indicator.gauge.th
reshold.Line` instance or dict with compatible
@@ -557,7 +557,7 @@ def __init__(
):
"""
Construct a new Gauge object
-
+
The gauge of the Indicator plot.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/_number.py b/packages/python/plotly/plotly/graph_objs/indicator/_number.py
index 2ac07e1730b..c960a7eaa53 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/_number.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/_number.py
@@ -16,17 +16,17 @@ class Number(_BaseTraceHierarchyType):
def font(self):
"""
Set the font used to display main number
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.number.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
@@ -62,7 +62,7 @@ def font(self, val):
def prefix(self):
"""
Sets a prefix appearing before the number.
-
+
The 'prefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -83,7 +83,7 @@ def prefix(self, val):
def suffix(self):
"""
Sets a suffix appearing next to the number.
-
+
The 'suffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -107,7 +107,7 @@ def valueformat(self):
language which is similar to those of Python. See
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'valueformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -145,7 +145,7 @@ def __init__(
):
"""
Construct a new Number object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/_stream.py b/packages/python/plotly/plotly/graph_objs/indicator/_stream.py
index d8b66f6e95a..b8671bcb40b 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/_title.py b/packages/python/plotly/plotly/graph_objs/indicator/_title.py
index 4fadefa94da..8d2b277754d 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/_title.py
@@ -18,7 +18,7 @@ def align(self):
Sets the horizontal alignment of the title. It defaults to
`center` except for bullet charts for which it defaults to
right.
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -39,17 +39,17 @@ def align(self, val):
def font(self):
"""
Set the font used to display the title
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.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
@@ -85,7 +85,7 @@ def font(self, val):
def text(self):
"""
Sets the title of this indicator.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, align=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/delta/_decreasing.py b/packages/python/plotly/plotly/graph_objs/indicator/delta/_decreasing.py
index d4df99687fb..088c1ebff38 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/delta/_decreasing.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/delta/_decreasing.py
@@ -16,7 +16,7 @@ class Decreasing(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color for increasing value.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def symbol(self):
"""
Sets the symbol to display for increasing value
-
+
The 'symbol' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -104,7 +104,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, symbol=None, **kwargs):
"""
Construct a new Decreasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/delta/_font.py b/packages/python/plotly/plotly/graph_objs/indicator/delta/_font.py
index ce2788a4d13..fab7d00284d 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/delta/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/delta/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Set the font used to display the delta
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/delta/_increasing.py b/packages/python/plotly/plotly/graph_objs/indicator/delta/_increasing.py
index ac3bdb6f164..020905015c7 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/delta/_increasing.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/delta/_increasing.py
@@ -16,7 +16,7 @@ class Increasing(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color for increasing value.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def symbol(self):
"""
Sets the symbol to display for increasing value
-
+
The 'symbol' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -104,7 +104,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, symbol=None, **kwargs):
"""
Construct a new Increasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_axis.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_axis.py
index 2bea413f889..750f8e8920e 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_axis.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_axis.py
@@ -64,7 +64,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -87,7 +87,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -132,7 +132,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -152,19 +152,19 @@ def nticks(self, val):
@property
def range(self):
"""
- Sets the range of this axis.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'range[1]' property is a number and may be specified as:
- - An int or float
+ Sets the range of this axis.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'range[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -178,7 +178,7 @@ def range(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -201,7 +201,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -222,7 +222,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -245,7 +245,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -266,7 +266,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -295,7 +295,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -316,7 +316,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -338,7 +338,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -397,17 +397,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.gauge.axis.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
@@ -450,7 +450,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -475,9 +475,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.indicator.gauge.axis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -531,13 +531,13 @@ def tickformatstopdefaults(self):
e.axis.tickformatstopdefaults), sets the default property
values to use for elements of
indicator.gauge.axis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -556,7 +556,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -582,7 +582,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -603,7 +603,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -626,7 +626,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -647,7 +647,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -670,7 +670,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -690,7 +690,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -711,7 +711,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -731,7 +731,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -751,7 +751,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -773,7 +773,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -965,7 +965,7 @@ def __init__(
):
"""
Construct a new Axis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_bar.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_bar.py
index abfc64a2353..39c7d4430bf 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_bar.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_bar.py
@@ -16,7 +16,7 @@ class Bar(_BaseTraceHierarchyType):
def color(self):
"""
Sets the background color of the arc.
-
+
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)')
@@ -79,9 +79,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.indicator.gauge.bar.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the line enclosing each
sector.
@@ -106,7 +106,7 @@ def thickness(self):
"""
Sets the thickness of the bar as a fraction of the total
thickness of the gauge.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -138,7 +138,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, line=None, thickness=None, **kwargs):
"""
Construct a new Bar object
-
+
Set the appearance of the gauge's value
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_step.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_step.py
index 9296a56a9b4..489de5d4ae2 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_step.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_step.py
@@ -16,7 +16,7 @@ class Step(_BaseTraceHierarchyType):
def color(self):
"""
Sets the background color of the arc.
-
+
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)')
@@ -79,9 +79,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.indicator.gauge.step.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the line enclosing each
sector.
@@ -111,7 +111,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -131,19 +131,19 @@ def name(self, val):
@property
def range(self):
"""
- Sets the range of this axis.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'range[1]' property is a number and may be specified as:
- - An int or float
+ Sets the range of this axis.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'range[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -164,7 +164,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -186,7 +186,7 @@ def thickness(self):
"""
Sets the thickness of the bar as a fraction of the total
thickness of the gauge.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -249,7 +249,7 @@ def __init__(
):
"""
Construct a new Step object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_threshold.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_threshold.py
index e5f48236769..902470fa20e 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/_threshold.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/_threshold.py
@@ -20,9 +20,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.indicator.gauge.threshold.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the threshold line.
width
@@ -45,7 +45,7 @@ def thickness(self):
"""
Sets the thickness of the threshold line as a fraction of the
thickness of the gauge.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -65,7 +65,7 @@ def thickness(self, val):
def value(self):
"""
Sets a treshold value drawn as a line.
-
+
The 'value' property is a number and may be specified as:
- An int or float
@@ -97,7 +97,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, line=None, thickness=None, value=None, **kwargs):
"""
Construct a new Threshold object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickfont.py
index ea35740a758..91dbbfa6f8b 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py
index c1229fce583..f7036e44ca0 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/_line.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/_line.py
index c0132130fa0..c959e765640 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/bar/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the line enclosing each sector.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the width (in px) of the line enclosing each sector.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -104,7 +104,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/_line.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/_line.py
index fcf22cae3ce..ba3ea08c8f2 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/step/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the line enclosing each sector.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the width (in px) of the line enclosing each sector.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -104,7 +104,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/_line.py b/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/_line.py
index a21ba9b2ba0..2a5b1268af6 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/gauge/threshold/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the threshold line.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the width (in px) of the threshold line.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/number/_font.py b/packages/python/plotly/plotly/graph_objs/indicator/number/_font.py
index 337645b3bc5..619687ba8ec 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/number/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/number/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Set the font used to display main number
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/indicator/title/_font.py b/packages/python/plotly/plotly/graph_objs/indicator/title/_font.py
index 16d4afb5ed1..ba0fab37673 100644
--- a/packages/python/plotly/plotly/graph_objs/indicator/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/indicator/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Set the font used to display the title
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_caps.py b/packages/python/plotly/plotly/graph_objs/isosurface/_caps.py
index bc890a7112b..405b3718d90 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_caps.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_caps.py
@@ -20,9 +20,9 @@ def x(self):
- An instance of :class:`plotly.graph_objs.isosurface.caps.X`
- A dict of string/value properties that will be passed
to the X constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `caps`. The default
fill value of the `caps` is 1 meaning that they
@@ -57,9 +57,9 @@ def y(self):
- An instance of :class:`plotly.graph_objs.isosurface.caps.Y`
- A dict of string/value properties that will be passed
to the Y constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `caps`. The default
fill value of the `caps` is 1 meaning that they
@@ -94,9 +94,9 @@ def z(self):
- An instance of :class:`plotly.graph_objs.isosurface.caps.Z`
- A dict of string/value properties that will be passed
to the Z constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `caps`. The default
fill value of the `caps` is 1 meaning that they
@@ -140,7 +140,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Caps object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_colorbar.py b/packages/python/plotly/plotly/graph_objs/isosurface/_colorbar.py
index 5df0f2eb517..41bbc7c6a6c 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.isosurface.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.isosurface.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -827,13 +827,13 @@ def tickformatstopdefaults(self):
When used in a template (as layout.template.data.isosurface.col
orbar.tickformatstopdefaults), sets the default property values
to use for elements of isosurface.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -852,7 +852,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -878,7 +878,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -899,7 +899,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -922,7 +922,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -943,7 +943,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -966,7 +966,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -986,7 +986,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1007,7 +1007,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1027,7 +1027,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1047,7 +1047,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1071,9 +1071,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.isosurface.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1108,17 +1108,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.isosurface.colorbar.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
@@ -1140,7 +1140,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1157,14 +1157,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1178,7 +1178,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1200,7 +1200,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1221,7 +1221,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1241,7 +1241,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1263,7 +1263,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1284,7 +1284,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1553,7 +1553,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_contour.py b/packages/python/plotly/plotly/graph_objs/isosurface/_contour.py
index 6b1e296780c..29d7afcdd3d 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_contour.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_contour.py
@@ -16,7 +16,7 @@ class Contour(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the contour lines.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def show(self):
"""
Sets whether or not dynamic contours are shown on hover
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -95,7 +95,7 @@ def show(self, val):
def width(self):
"""
Sets the width of the contour lines.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, show=None, width=None, **kwargs):
"""
Construct a new Contour object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/isosurface/_hoverlabel.py
index 96c70877e5e..fb5f7be1397 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.isosurface.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_lighting.py b/packages/python/plotly/plotly/graph_objs/isosurface/_lighting.py
index 148e85e15ee..cb1129e0569 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_lighting.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_lighting.py
@@ -25,7 +25,7 @@ def ambient(self):
"""
Ambient light increases overall color visibility but can wash
out the image.
-
+
The 'ambient' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -46,7 +46,7 @@ def diffuse(self):
"""
Represents the extent that incident rays are reflected in a
range of angles.
-
+
The 'diffuse' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -67,7 +67,7 @@ def facenormalsepsilon(self):
"""
Epsilon for face normals calculation avoids math issues arising
from degenerate geometry.
-
+
The 'facenormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -89,7 +89,7 @@ def fresnel(self):
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.
-
+
The 'fresnel' property is a number and may be specified as:
- An int or float in the interval [0, 5]
@@ -110,7 +110,7 @@ def roughness(self):
"""
Alters specular reflection; the rougher the surface, the wider
and less contrasty the shine.
-
+
The 'roughness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -131,7 +131,7 @@ def specular(self):
"""
Represents the level that incident rays are reflected in a
single direction, causing shine.
-
+
The 'specular' property is a number and may be specified as:
- An int or float in the interval [0, 2]
@@ -152,7 +152,7 @@ def vertexnormalsepsilon(self):
"""
Epsilon for vertex normals calculation avoids math issues
arising from degenerate geometry.
-
+
The 'vertexnormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -210,7 +210,7 @@ def __init__(
):
"""
Construct a new Lighting object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_lightposition.py b/packages/python/plotly/plotly/graph_objs/isosurface/_lightposition.py
index 8dabfe14c89..606b711ef8b 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_lightposition.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_lightposition.py
@@ -16,7 +16,7 @@ class Lightposition(_BaseTraceHierarchyType):
def x(self):
"""
Numeric vector, representing the X coordinate for each vertex.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -36,7 +36,7 @@ def x(self, val):
def y(self):
"""
Numeric vector, representing the Y coordinate for each vertex.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -56,7 +56,7 @@ def y(self, val):
def z(self):
"""
Numeric vector, representing the Z coordinate for each vertex.
-
+
The 'z' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Lightposition object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_slices.py b/packages/python/plotly/plotly/graph_objs/isosurface/_slices.py
index 1ad050a3c26..b8d6f077b08 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_slices.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_slices.py
@@ -20,9 +20,9 @@ def x(self):
- An instance of :class:`plotly.graph_objs.isosurface.slices.X`
- A dict of string/value properties that will be passed
to the X constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `slices`. The
default fill value of the `slices` is 1 meaning
@@ -62,9 +62,9 @@ def y(self):
- An instance of :class:`plotly.graph_objs.isosurface.slices.Y`
- A dict of string/value properties that will be passed
to the Y constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `slices`. The
default fill value of the `slices` is 1 meaning
@@ -104,9 +104,9 @@ def z(self):
- An instance of :class:`plotly.graph_objs.isosurface.slices.Z`
- A dict of string/value properties that will be passed
to the Z constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `slices`. The
default fill value of the `slices` is 1 meaning
@@ -155,7 +155,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Slices object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_spaceframe.py b/packages/python/plotly/plotly/graph_objs/isosurface/_spaceframe.py
index 7f13fec68fd..d58019ebf5f 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_spaceframe.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_spaceframe.py
@@ -20,7 +20,7 @@ def fill(self):
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).
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def show(self):
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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -78,7 +78,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new Spaceframe object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_stream.py b/packages/python/plotly/plotly/graph_objs/isosurface/_stream.py
index 21aea9415b1..c55bc12939e 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/_surface.py b/packages/python/plotly/plotly/graph_objs/isosurface/_surface.py
index f0781da993e..ebb3d91ba0f 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/_surface.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/_surface.py
@@ -18,7 +18,7 @@ def count(self):
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.
-
+
The 'count' 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]
@@ -42,7 +42,7 @@ def fill(self):
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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -68,7 +68,7 @@ def pattern(self):
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.
-
+
The 'pattern' property is a flaglist and may be specified
as a string containing:
- Any combination of ['A', 'B', 'C', 'D', 'E'] joined with '+' characters
@@ -91,7 +91,7 @@ def pattern(self, val):
def show(self):
"""
Hides/displays surfaces between minimum and maximum iso-values.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -140,7 +140,7 @@ def __init__(
):
"""
Construct a new Surface object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/caps/_x.py b/packages/python/plotly/plotly/graph_objs/isosurface/caps/_x.py
index ffa1c73812e..54dc4bc3b2c 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/caps/_x.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/caps/_x.py
@@ -19,7 +19,7 @@ def fill(self):
the `caps` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def show(self):
the x `slices` 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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -78,7 +78,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new X object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/caps/_y.py b/packages/python/plotly/plotly/graph_objs/isosurface/caps/_y.py
index 1215b7f1792..8a2d58cbe9f 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/caps/_y.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/caps/_y.py
@@ -19,7 +19,7 @@ def fill(self):
the `caps` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def show(self):
the y `slices` 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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -78,7 +78,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new Y object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/caps/_z.py b/packages/python/plotly/plotly/graph_objs/isosurface/caps/_z.py
index d3edbcd69a7..68897dc0eda 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/caps/_z.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/caps/_z.py
@@ -19,7 +19,7 @@ def fill(self):
the `caps` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def show(self):
the z `slices` 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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -78,7 +78,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new Z object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickfont.py
index 8e184c4f2e2..c698df0f5fd 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py
index d7ffc220020..38a0dd908f3 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_title.py
index fbe476f7530..4c28d4fdbaa 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.isosurface.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/_font.py
index a9759438de3..d0857ef7caf 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/_font.py
index 8e314c9a660..20a66260767 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/slices/_x.py b/packages/python/plotly/plotly/graph_objs/isosurface/slices/_x.py
index e7c3d4cdea1..444b025dcbc 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/slices/_x.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/slices/_x.py
@@ -19,7 +19,7 @@ def fill(self):
the `slices` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -41,7 +41,7 @@ def locations(self):
Specifies the location(s) of slices on the axis. When not
specified slices would be created for all points of the axis x
except start and end.
-
+
The 'locations' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -62,7 +62,7 @@ def locationssrc(self):
"""
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
@@ -83,7 +83,7 @@ def show(self):
"""
Determines whether or not slice planes about the x dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -131,7 +131,7 @@ def __init__(
):
"""
Construct a new X object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/slices/_y.py b/packages/python/plotly/plotly/graph_objs/isosurface/slices/_y.py
index 9fb2544cf00..303489309ba 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/slices/_y.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/slices/_y.py
@@ -19,7 +19,7 @@ def fill(self):
the `slices` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -41,7 +41,7 @@ def locations(self):
Specifies the location(s) of slices on the axis. When not
specified slices would be created for all points of the axis y
except start and end.
-
+
The 'locations' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -62,7 +62,7 @@ def locationssrc(self):
"""
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
@@ -83,7 +83,7 @@ def show(self):
"""
Determines whether or not slice planes about the y dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -131,7 +131,7 @@ def __init__(
):
"""
Construct a new Y object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/isosurface/slices/_z.py b/packages/python/plotly/plotly/graph_objs/isosurface/slices/_z.py
index 7d3fb4f58d2..5188153a3c3 100644
--- a/packages/python/plotly/plotly/graph_objs/isosurface/slices/_z.py
+++ b/packages/python/plotly/plotly/graph_objs/isosurface/slices/_z.py
@@ -19,7 +19,7 @@ def fill(self):
the `slices` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -41,7 +41,7 @@ def locations(self):
Specifies the location(s) of slices on the axis. When not
specified slices would be created for all points of the axis z
except start and end.
-
+
The 'locations' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -62,7 +62,7 @@ def locationssrc(self):
"""
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
@@ -83,7 +83,7 @@ def show(self):
"""
Determines whether or not slice planes about the z dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -131,7 +131,7 @@ def __init__(
):
"""
Construct a new Z object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_activeshape.py b/packages/python/plotly/plotly/graph_objs/layout/_activeshape.py
index d2dbd735b9b..92e8aafea6d 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_activeshape.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_activeshape.py
@@ -16,7 +16,7 @@ class Activeshape(_BaseLayoutHierarchyType):
def fillcolor(self):
"""
Sets the color filling the active shape' interior.
-
+
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)')
@@ -75,7 +75,7 @@ def fillcolor(self, val):
def opacity(self):
"""
Sets the opacity of the active shape.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fillcolor=None, opacity=None, **kwargs):
"""
Construct a new Activeshape object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_angularaxis.py b/packages/python/plotly/plotly/graph_objs/layout/_angularaxis.py
index 22192e5ff2d..6d8b4eab745 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_angularaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_angularaxis.py
@@ -26,20 +26,20 @@ class AngularAxis(_BaseLayoutHierarchyType):
@property
def domain(self):
"""
- Polar chart subplots are not supported yet. This key has
- currently no effect.
-
- The 'domain' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'domain[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'domain[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Polar chart subplots are not supported yet. This key has
+ currently no effect.
- Returns
- -------
- list
+ The 'domain' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'domain[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'domain[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["domain"]
@@ -54,7 +54,7 @@ def endpadding(self):
"""
Legacy polar charts are deprecated! Please switch to "polar"
subplots.
-
+
The 'endpadding' property is a number and may be specified as:
- An int or float
@@ -73,20 +73,20 @@ def endpadding(self, val):
@property
def range(self):
"""
- Legacy polar charts are deprecated! Please switch to "polar"
- subplots. Defines the start and end point of this angular axis.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'range[1]' property is a number and may be specified as:
- - An int or float
+ Legacy polar charts are deprecated! Please switch to "polar"
+ subplots. Defines the start and end point of this angular axis.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'range[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -102,7 +102,7 @@ def showline(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Determines whether or not the line bounding this
angular axis will be shown on the figure.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -124,7 +124,7 @@ def showticklabels(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Determines whether or not the angular axis ticks will
feature tick labels.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -146,7 +146,7 @@ def tickcolor(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the color of the tick lines on this angular
axis.
-
+
The 'tickcolor' 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)')
@@ -207,7 +207,7 @@ def ticklen(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the length of the tick lines on this angular
axis.
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -229,7 +229,7 @@ def tickorientation(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the orientation (from the paper perspective) of
the angular axis tick labels.
-
+
The 'tickorientation' property is an enumeration that may be specified as:
- One of the following enumeration values:
['horizontal', 'vertical']
@@ -252,7 +252,7 @@ def ticksuffix(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the length of the tick lines on this angular
axis.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -274,7 +274,7 @@ def visible(self):
"""
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Determines whether or not this axis will be visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -350,7 +350,7 @@ def __init__(
):
"""
Construct a new AngularAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_annotation.py b/packages/python/plotly/plotly/graph_objs/layout/_annotation.py
index 162d001b04c..755d4d84b6f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_annotation.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_annotation.py
@@ -63,7 +63,7 @@ def align(self):
an effect only if `text` spans two or more lines (i.e. `text`
contains one or more
HTML tags) or if an explicit width is
set to override the text width.
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -84,7 +84,7 @@ def align(self, val):
def arrowcolor(self):
"""
Sets the color of the annotation arrow.
-
+
The 'arrowcolor' 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)')
@@ -143,7 +143,7 @@ def arrowcolor(self, val):
def arrowhead(self):
"""
Sets the end annotation arrow head style.
-
+
The 'arrowhead' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
in the interval [0, 8]
@@ -164,7 +164,7 @@ def arrowhead(self, val):
def arrowside(self):
"""
Sets the annotation arrow head position.
-
+
The 'arrowside' property is a flaglist and may be specified
as a string containing:
- Any combination of ['end', 'start'] joined with '+' characters
@@ -189,7 +189,7 @@ def arrowsize(self):
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.
-
+
The 'arrowsize' property is a number and may be specified as:
- An int or float in the interval [0.3, inf]
@@ -209,7 +209,7 @@ def arrowsize(self, val):
def arrowwidth(self):
"""
Sets the width (in px) of annotation arrow line.
-
+
The 'arrowwidth' property is a number and may be specified as:
- An int or float in the interval [0.1, inf]
@@ -234,7 +234,7 @@ def ax(self):
`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`.
-
+
The 'ax' property accepts values of any type
Returns
@@ -273,7 +273,7 @@ def axref(self):
continue to indicate the correct trend when zoomed. Relative
positioning is useful for specifying the text offset for an
annotated point.
-
+
The 'axref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['pixel']
@@ -301,7 +301,7 @@ def ay(self):
`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`.
-
+
The 'ay' property accepts values of any type
Returns
@@ -319,6 +319,14 @@ def ay(self, val):
@property
def ayref(self):
"""
+ Indicates in what terms the tail of the annotation (ax,ay) is
+ specified. If `pixel`, `ay` is a relative offset in pixels
+ from `y`. If set to a y axis id (e.g. "y" or "y2"), `ay` is
+ specified in the same terms as that axis. This is useful for
+ trendline annotations which should continue to indicate the
+ correct trend when zoomed.
+
+=======
Indicates in what coordinates the tail of the annotation
(ax,ay) is specified. If set to a ay axis id (e.g. "ay" or
"ay2"), the `ay` position refers to a ay coordinate. If set to
@@ -340,7 +348,7 @@ def ayref(self):
continue to indicate the correct trend when zoomed. Relative
positioning is useful for specifying the text offset for an
annotated point.
-
+
The 'ayref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['pixel']
@@ -363,7 +371,7 @@ def ayref(self, val):
def bgcolor(self):
"""
Sets the background color of the annotation.
-
+
The '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)')
@@ -422,7 +430,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the color of the border enclosing the annotation `text`.
-
+
The 'bordercolor' 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)')
@@ -482,7 +490,7 @@ def borderpad(self):
"""
Sets the padding (in px) between the `text` and the enclosing
border.
-
+
The 'borderpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -503,7 +511,7 @@ def borderwidth(self):
"""
Sets the width (in px) of the border enclosing the annotation
`text`.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -528,7 +536,7 @@ def captureevents(self):
default `captureevents` is False unless `hovertext` is
provided. If you use the event `plotly_clickannotation` without
`hovertext` you must explicitly enable `captureevents`.
-
+
The 'captureevents' property must be specified as a bool
(either True, or False)
@@ -559,7 +567,7 @@ def clicktoshow(self):
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`.
-
+
The 'clicktoshow' property is an enumeration that may be specified as:
- One of the following enumeration values:
[False, 'onoff', 'onout']
@@ -580,17 +588,17 @@ def clicktoshow(self, val):
def font(self):
"""
Sets the annotation text font.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.annotation.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
@@ -627,7 +635,7 @@ def height(self):
"""
Sets an explicit height for the text box. null (default) lets
the text set the box height. Taller text will be clipped.
-
+
The 'height' property is a number and may be specified as:
- An int or float in the interval [1, inf]
@@ -651,9 +659,9 @@ def hoverlabel(self):
- An instance of :class:`plotly.graph_objs.layout.annotation.Hoverlabel`
- A dict of string/value properties that will be passed
to the Hoverlabel constructor
-
+
Supported dict properties:
-
+
bgcolor
Sets the background color of the hover label.
By default uses the annotation's `bgcolor` made
@@ -684,7 +692,7 @@ def hovertext(self):
"""
Sets text to appear when hovering over this annotation. If
omitted or blank, no hover label will appear.
-
+
The 'hovertext' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -711,7 +719,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -732,7 +740,7 @@ def name(self, val):
def opacity(self):
"""
Sets the opacity of the annotation (text + arrow).
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -754,7 +762,7 @@ def showarrow(self):
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.
-
+
The 'showarrow' property must be specified as a bool
(either True, or False)
@@ -778,7 +786,7 @@ def standoff(self):
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.
-
+
The 'standoff' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -798,7 +806,7 @@ def standoff(self, val):
def startarrowhead(self):
"""
Sets the start annotation arrow head style.
-
+
The 'startarrowhead' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
in the interval [0, 8]
@@ -821,7 +829,7 @@ def startarrowsize(self):
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.
-
+
The 'startarrowsize' property is a number and may be specified as:
- An int or float in the interval [0.3, inf]
@@ -845,7 +853,7 @@ def startstandoff(self):
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.
-
+
The 'startstandoff' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -872,7 +880,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -896,7 +904,7 @@ def text(self):
subset of HTML tags to do things like newline (
), bold
(), italics (), hyperlinks ().
Tags , , are also supported.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -918,7 +926,7 @@ def textangle(self):
"""
Sets the angle at which the `text` is drawn with respect to the
horizontal.
-
+
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
@@ -942,7 +950,7 @@ def valign(self):
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.
-
+
The 'valign' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -963,7 +971,7 @@ def valign(self, val):
def visible(self):
"""
Determines whether or not this annotation is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -985,7 +993,7 @@ def width(self):
Sets an explicit width for the text box. null (default) lets
the text set the box width. Wider text will be clipped. There
is no automatic wrapping; use
to start a new line.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, inf]
@@ -1011,7 +1019,7 @@ def x(self):
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.
-
+
The 'x' property accepts values of any type
Returns
@@ -1038,7 +1046,7 @@ def xanchor(self):
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.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'left', 'center', 'right']
@@ -1060,7 +1068,7 @@ def xclick(self):
"""
Toggle this annotation when clicking a data point whose `x`
value is `xclick` rather than the annotation's `x` value.
-
+
The 'xclick' property accepts values of any type
Returns
@@ -1089,7 +1097,7 @@ def xref(self):
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.
-
+
The 'xref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['paper']
@@ -1113,7 +1121,7 @@ def xshift(self):
"""
Shifts the position of the whole annotation and arrow to the
right (positive) or left (negative) by this many pixels.
-
+
The 'xshift' property is a number and may be specified as:
- An int or float
@@ -1139,7 +1147,7 @@ def y(self):
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.
-
+
The 'y' property accepts values of any type
Returns
@@ -1166,7 +1174,7 @@ def yanchor(self):
referenced annotations or if there is an arrow, whereas for
paper-referenced with no arrow, the anchor picked corresponds
to the closest side.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'top', 'middle', 'bottom']
@@ -1188,7 +1196,7 @@ def yclick(self):
"""
Toggle this annotation when clicking a data point whose `y`
value is `yclick` rather than the annotation's `y` value.
-
+
The 'yclick' property accepts values of any type
Returns
@@ -1217,7 +1225,7 @@ def yref(self):
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.
-
+
The 'yref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['paper']
@@ -1241,7 +1249,7 @@ def yshift(self):
"""
Shifts the position of the whole annotation and arrow up
(positive) or down (negative) by this many pixels.
-
+
The 'yshift' property is a number and may be specified as:
- An int or float
@@ -1590,7 +1598,7 @@ def __init__(
):
"""
Construct a new Annotation object
-
+
Parameters
----------
arg
@@ -1897,8 +1905,8 @@ def __init__(
else:
raise ValueError(
"""\
-The first argument to the plotly.graph_objs.layout.Annotation
-constructor must be a dict or
+The first argument to the plotly.graph_objs.layout.Annotation
+constructor must be a dict or
an instance of :class:`plotly.graph_objs.layout.Annotation`"""
)
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_coloraxis.py b/packages/python/plotly/plotly/graph_objs/layout/_coloraxis.py
index c6dcb79c82b..b825f76583e 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_coloraxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_coloraxis.py
@@ -31,7 +31,7 @@ def autocolorscale(self):
`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)
@@ -54,7 +54,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -76,7 +76,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -99,7 +99,7 @@ def cmid(self):
`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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -121,7 +121,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -145,9 +145,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.layout.coloraxis.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
@@ -389,14 +389,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -434,7 +434,7 @@ def reversescale(self):
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)
@@ -455,7 +455,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -540,7 +540,7 @@ def __init__(
):
"""
Construct a new Coloraxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_colorscale.py b/packages/python/plotly/plotly/graph_objs/layout/_colorscale.py
index d4385fafa71..ba2c941c443 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_colorscale.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_colorscale.py
@@ -17,14 +17,14 @@ def diverging(self):
"""
Sets the default diverging colorscale. Note that
`autocolorscale` must be true for this attribute to work.
-
+
The 'diverging' 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),
+ 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:
@@ -62,14 +62,14 @@ def sequential(self):
Sets the default sequential colorscale for positive values.
Note that `autocolorscale` must be true for this attribute to
work.
-
+
The 'sequential' 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),
+ 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:
@@ -107,14 +107,14 @@ def sequentialminus(self):
Sets the default sequential colorscale for negative values.
Note that `autocolorscale` must be true for this attribute to
work.
-
+
The 'sequentialminus' 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),
+ 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:
@@ -168,7 +168,7 @@ def __init__(
):
"""
Construct a new Colorscale object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_font.py b/packages/python/plotly/plotly/graph_objs/layout/_font.py
index 89676ee4264..9b7ac53fccd 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the global font. Note that fonts used in traces and other
layout components inherit from the global font.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_geo.py b/packages/python/plotly/plotly/graph_objs/layout/_geo.py
index 859c6e5d641..29e70a05330 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_geo.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_geo.py
@@ -49,7 +49,7 @@ class Geo(_BaseLayoutHierarchyType):
def bgcolor(self):
"""
Set the background color of the map
-
+
The '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)')
@@ -112,9 +112,9 @@ def center(self):
- An instance of :class:`plotly.graph_objs.layout.geo.Center`
- A dict of string/value properties that will be passed
to the Center constructor
-
+
Supported dict properties:
-
+
lat
Sets the latitude of the map's center. For all
projection types, the map's latitude center
@@ -143,7 +143,7 @@ def center(self, val):
def coastlinecolor(self):
"""
Sets the coastline color.
-
+
The 'coastlinecolor' 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)')
@@ -202,7 +202,7 @@ def coastlinecolor(self, val):
def coastlinewidth(self):
"""
Sets the coastline stroke width (in px).
-
+
The 'coastlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -222,7 +222,7 @@ def coastlinewidth(self, val):
def countrycolor(self):
"""
Sets line color of the country boundaries.
-
+
The 'countrycolor' 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)')
@@ -281,7 +281,7 @@ def countrycolor(self, val):
def countrywidth(self):
"""
Sets line width (in px) of the country boundaries.
-
+
The 'countrywidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -305,9 +305,9 @@ def domain(self):
- An instance of :class:`plotly.graph_objs.layout.geo.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 geo subplot .
@@ -363,7 +363,7 @@ def fitbounds(self):
in the `fitbounds` computations. If "geojson", the entire trace
input `geojson` (if provided) is considered in the `fitbounds`
computations, Defaults to False.
-
+
The 'fitbounds' property is an enumeration that may be specified as:
- One of the following enumeration values:
[False, 'locations', 'geojson']
@@ -384,7 +384,7 @@ def fitbounds(self, val):
def framecolor(self):
"""
Sets the color the frame.
-
+
The 'framecolor' 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)')
@@ -443,7 +443,7 @@ def framecolor(self, val):
def framewidth(self):
"""
Sets the stroke width (in px) of the frame.
-
+
The 'framewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -463,7 +463,7 @@ def framewidth(self, val):
def lakecolor(self):
"""
Sets the color of the lakes.
-
+
The 'lakecolor' 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)')
@@ -522,7 +522,7 @@ def lakecolor(self, val):
def landcolor(self):
"""
Sets the land mass color.
-
+
The 'landcolor' 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)')
@@ -585,9 +585,9 @@ def lataxis(self):
- An instance of :class:`plotly.graph_objs.layout.geo.Lataxis`
- A dict of string/value properties that will be passed
to the Lataxis constructor
-
+
Supported dict properties:
-
+
dtick
Sets the graticule's longitude/latitude tick
step.
@@ -625,9 +625,9 @@ def lonaxis(self):
- An instance of :class:`plotly.graph_objs.layout.geo.Lonaxis`
- A dict of string/value properties that will be passed
to the Lonaxis constructor
-
+
Supported dict properties:
-
+
dtick
Sets the graticule's longitude/latitude tick
step.
@@ -661,7 +661,7 @@ def lonaxis(self, val):
def oceancolor(self):
"""
Sets the ocean color
-
+
The 'oceancolor' 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)')
@@ -724,9 +724,9 @@ def projection(self):
- An instance of :class:`plotly.graph_objs.layout.geo.Projection`
- A dict of string/value properties that will be passed
to the Projection constructor
-
+
Supported dict properties:
-
+
parallels
For conic projection types only. Sets the
parallels (tangent, secant) where the cone
@@ -760,7 +760,7 @@ def resolution(self):
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.
-
+
The 'resolution' property is an enumeration that may be specified as:
- One of the following enumeration values:
[110, 50]
@@ -781,7 +781,7 @@ def resolution(self, val):
def rivercolor(self):
"""
Sets color of the rivers.
-
+
The 'rivercolor' 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)')
@@ -840,7 +840,7 @@ def rivercolor(self, val):
def riverwidth(self):
"""
Sets the stroke width (in px) of the rivers.
-
+
The 'riverwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -860,7 +860,7 @@ def riverwidth(self, val):
def scope(self):
"""
Set the scope of the map.
-
+
The 'scope' property is an enumeration that may be specified as:
- One of the following enumeration values:
['world', 'usa', 'europe', 'asia', 'africa', 'north
@@ -882,7 +882,7 @@ def scope(self, val):
def showcoastlines(self):
"""
Sets whether or not the coastlines are drawn.
-
+
The 'showcoastlines' property must be specified as a bool
(either True, or False)
@@ -902,7 +902,7 @@ def showcoastlines(self, val):
def showcountries(self):
"""
Sets whether or not country boundaries are drawn.
-
+
The 'showcountries' property must be specified as a bool
(either True, or False)
@@ -922,7 +922,7 @@ def showcountries(self, val):
def showframe(self):
"""
Sets whether or not a frame is drawn around the map.
-
+
The 'showframe' property must be specified as a bool
(either True, or False)
@@ -942,7 +942,7 @@ def showframe(self, val):
def showlakes(self):
"""
Sets whether or not lakes are drawn.
-
+
The 'showlakes' property must be specified as a bool
(either True, or False)
@@ -962,7 +962,7 @@ def showlakes(self, val):
def showland(self):
"""
Sets whether or not land masses are filled in color.
-
+
The 'showland' property must be specified as a bool
(either True, or False)
@@ -982,7 +982,7 @@ def showland(self, val):
def showocean(self):
"""
Sets whether or not oceans are filled in color.
-
+
The 'showocean' property must be specified as a bool
(either True, or False)
@@ -1002,7 +1002,7 @@ def showocean(self, val):
def showrivers(self):
"""
Sets whether or not rivers are drawn.
-
+
The 'showrivers' property must be specified as a bool
(either True, or False)
@@ -1023,7 +1023,7 @@ def showsubunits(self):
"""
Sets whether or not boundaries of subunits within countries
(e.g. states, provinces) are drawn.
-
+
The 'showsubunits' property must be specified as a bool
(either True, or False)
@@ -1043,7 +1043,7 @@ def showsubunits(self, val):
def subunitcolor(self):
"""
Sets the color of the subunits boundaries.
-
+
The 'subunitcolor' 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)')
@@ -1102,7 +1102,7 @@ def subunitcolor(self, val):
def subunitwidth(self):
"""
Sets the stroke width (in px) of the subunits boundaries.
-
+
The 'subunitwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1123,7 +1123,7 @@ def uirevision(self):
"""
Controls persistence of user-driven changes in the view
(projection and center). Defaults to `layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -1142,7 +1142,7 @@ def uirevision(self, val):
def visible(self):
"""
Sets the default visibility of the base layers.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -1291,7 +1291,7 @@ def __init__(
):
"""
Construct a new Geo object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_grid.py b/packages/python/plotly/plotly/graph_objs/layout/_grid.py
index c042fe60a30..ba9d9b089f4 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_grid.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_grid.py
@@ -34,7 +34,7 @@ def columns(self):
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.
-
+
The 'columns' 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]
@@ -59,9 +59,9 @@ def domain(self):
- An instance of :class:`plotly.graph_objs.layout.grid.Domain`
- A dict of string/value properties that will be passed
to the Domain constructor
-
+
Supported dict properties:
-
+
x
Sets the horizontal domain of this grid subplot
(in plot fraction). The first and last cells
@@ -94,7 +94,7 @@ def pattern(self):
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`.
-
+
The 'pattern' property is an enumeration that may be specified as:
- One of the following enumeration values:
['independent', 'coupled']
@@ -116,7 +116,7 @@ def roworder(self):
"""
Is the first row the top or the bottom? Note that columns are
always enumerated from left to right.
-
+
The 'roworder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top to bottom', 'bottom to top']
@@ -140,7 +140,7 @@ def rows(self):
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.
-
+
The 'rows' 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]
@@ -167,7 +167,7 @@ def subplots(self):
within the same row. Non-cartesian subplots and traces that
support `domain` can place themselves in this grid separately
using the `gridcell` attribute.
-
+
The 'subplots' property is an info array that may be specified as:
* a 2D list where:
The 'subplots[i][j]' property is an enumeration that may be specified as:
@@ -197,7 +197,7 @@ def xaxes(self):
other than "" must be unique. Ignored if `subplots` is present.
If missing but `yaxes` is present, will generate consecutive
IDs.
-
+
The 'xaxes' property is an info array that may be specified as:
* a list of elements where:
The 'xaxes[i]' property is an enumeration that may be specified as:
@@ -224,7 +224,7 @@ def xgap(self):
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.
-
+
The 'xgap' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -246,7 +246,7 @@ def xside(self):
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.
-
+
The 'xside' property is an enumeration that may be specified as:
- One of the following enumeration values:
['bottom', 'bottom plot', 'top plot', 'top']
@@ -272,7 +272,7 @@ def yaxes(self):
other than "" must be unique. Ignored if `subplots` is present.
If missing but `xaxes` is present, will generate consecutive
IDs.
-
+
The 'yaxes' property is an info array that may be specified as:
* a list of elements where:
The 'yaxes[i]' property is an enumeration that may be specified as:
@@ -299,7 +299,7 @@ def ygap(self):
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.
-
+
The 'ygap' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -322,7 +322,7 @@ def yside(self):
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.
-
+
The 'yside' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'left plot', 'right plot', 'right']
@@ -433,7 +433,7 @@ def __init__(
):
"""
Construct a new Grid object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/layout/_hoverlabel.py
index 632c71b9f31..ebc81ca0540 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_hoverlabel.py
@@ -18,7 +18,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -39,7 +39,7 @@ def align(self, val):
def bgcolor(self):
"""
Sets the background color of all hover labels on graph
-
+
The '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)')
@@ -98,7 +98,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the border color of all hover labels on graph.
-
+
The 'bordercolor' 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)')
@@ -158,17 +158,17 @@ def font(self):
"""
Sets the default hover label font used by all traces on the
graph.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.hoverlabel.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
@@ -209,7 +209,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -262,7 +262,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_image.py b/packages/python/plotly/plotly/graph_objs/layout/_image.py
index dbd4cbf4ba6..bbdebc6e224 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_image.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_image.py
@@ -34,7 +34,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['below', 'above']
@@ -61,7 +61,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -82,7 +82,7 @@ def name(self, val):
def opacity(self):
"""
Sets the opacity of the image.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -106,7 +106,7 @@ def sizex(self):
`paper`, units are sized relative to the plot width. When
`xref` ends with ` domain`, units are sized relative to the
axis width.
-
+
The 'sizex' property is a number and may be specified as:
- An int or float
@@ -130,7 +130,7 @@ def sizey(self):
`paper`, units are sized relative to the plot height. When
`yref` ends with ` domain`, units are sized relative to the
axis height.
-
+
The 'sizey' property is a number and may be specified as:
- An int or float
@@ -150,7 +150,7 @@ def sizey(self, val):
def sizing(self):
"""
Specifies which dimension of the image to constrain.
-
+
The 'sizing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fill', 'contain', 'stretch']
@@ -173,7 +173,7 @@ def source(self):
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.
-
+
The 'source' property is an image URI that may be specified as:
- A remote image URI string
(e.g. 'http://www.somewhere.com/image.png')
@@ -206,7 +206,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -227,7 +227,7 @@ def templateitemname(self, val):
def visible(self):
"""
Determines whether or not this image is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -249,7 +249,7 @@ def x(self):
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
-
+
The 'x' property accepts values of any type
Returns
@@ -268,7 +268,7 @@ def x(self, val):
def xanchor(self):
"""
Sets the anchor for the x position
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -299,7 +299,7 @@ def xref(self):
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.
-
+
The 'xref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['paper']
@@ -324,7 +324,7 @@ def y(self):
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
-
+
The 'y' property accepts values of any type
Returns
@@ -343,7 +343,7 @@ def y(self, val):
def yanchor(self):
"""
Sets the anchor for the y position.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -374,7 +374,7 @@ def yref(self):
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.
-
+
The 'yref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['paper']
@@ -505,7 +505,7 @@ def __init__(
):
"""
Construct a new Image object
-
+
Parameters
----------
arg
@@ -618,8 +618,8 @@ def __init__(
else:
raise ValueError(
"""\
-The first argument to the plotly.graph_objs.layout.Image
-constructor must be a dict or
+The first argument to the plotly.graph_objs.layout.Image
+constructor must be a dict or
an instance of :class:`plotly.graph_objs.layout.Image`"""
)
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_legend.py b/packages/python/plotly/plotly/graph_objs/layout/_legend.py
index a4c466dc6fa..b4e82cc5828 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_legend.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_legend.py
@@ -35,7 +35,7 @@ def bgcolor(self):
"""
Sets the legend background color. Defaults to
`layout.paper_bgcolor`.
-
+
The '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)')
@@ -94,7 +94,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the color of the border enclosing the legend.
-
+
The 'bordercolor' 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)')
@@ -153,7 +153,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) of the border enclosing the legend.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -173,17 +173,17 @@ def borderwidth(self, val):
def font(self):
"""
Sets the font used to text the legend items.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.legend.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
@@ -222,7 +222,7 @@ def itemclick(self):
the visibility of the item clicked on the graph. "toggleothers"
makes the clicked item the sole visible item on the graph.
False disable legend item click interactions.
-
+
The 'itemclick' property is an enumeration that may be specified as:
- One of the following enumeration values:
['toggle', 'toggleothers', False]
@@ -246,7 +246,7 @@ def itemdoubleclick(self):
toggles the visibility of the item clicked on the graph.
"toggleothers" makes the clicked item the sole visible item on
the graph. False disable legend item double-click interactions.
-
+
The 'itemdoubleclick' property is an enumeration that may be specified as:
- One of the following enumeration values:
['toggle', 'toggleothers', False]
@@ -269,7 +269,7 @@ def itemsizing(self):
Determines if the legend items symbols scale with their
corresponding "trace" attributes or remain "constant"
independent of the symbol size on the graph.
-
+
The 'itemsizing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'constant']
@@ -290,7 +290,7 @@ def itemsizing(self, val):
def orientation(self):
"""
Sets the orientation of the legend.
-
+
The 'orientation' property is an enumeration that may be specified as:
- One of the following enumeration values:
['v', 'h']
@@ -315,9 +315,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.legend.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this legend's title font.
side
@@ -347,7 +347,7 @@ def tracegroupgap(self):
"""
Sets the amount of vertical space (in px) between legend
groups.
-
+
The 'tracegroupgap' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -373,7 +373,7 @@ def traceorder(self):
displayed in groups (when a trace `legendgroup` is provided).
if "grouped+reversed", the items are displayed in the opposite
order as "grouped".
-
+
The 'traceorder' property is a flaglist and may be specified
as a string containing:
- Any combination of ['reversed', 'grouped'] joined with '+' characters
@@ -397,7 +397,7 @@ def uirevision(self):
"""
Controls persistence of legend-driven changes in trace and pie
label visibility. Defaults to `layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -417,7 +417,7 @@ def valign(self):
"""
Sets the vertical alignment of the symbols with respect to
their associated text.
-
+
The 'valign' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -440,7 +440,7 @@ def x(self):
Sets the x position (in normalized coordinates) of the legend.
Defaults to 1.02 for vertical legends and defaults to 0 for
horizontal legends.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -465,7 +465,7 @@ def xanchor(self):
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.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'left', 'center', 'right']
@@ -490,7 +490,7 @@ def y(self):
horizontal legends on graphs w/o range sliders and defaults to
1.1 for horizontal legends on graph with one or multiple range
sliders.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -515,7 +515,7 @@ def yanchor(self):
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.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'top', 'middle', 'bottom']
@@ -637,7 +637,7 @@ def __init__(
):
"""
Construct a new Legend object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_mapbox.py b/packages/python/plotly/plotly/graph_objs/layout/_mapbox.py
index 3d89246cdda..67b43100373 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_mapbox.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_mapbox.py
@@ -32,7 +32,7 @@ def accesstoken(self):
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.
-
+
The 'accesstoken' property is a string and must be specified as:
- A non-empty string
@@ -53,7 +53,7 @@ def bearing(self):
"""
Sets the bearing angle of the map in degrees counter-clockwise
from North (mapbox.bearing).
-
+
The 'bearing' property is a number and may be specified as:
- An int or float
@@ -77,9 +77,9 @@ def center(self):
- An instance of :class:`plotly.graph_objs.layout.mapbox.Center`
- A dict of string/value properties that will be passed
to the Center constructor
-
+
Supported dict properties:
-
+
lat
Sets the latitude of the center of the map (in
degrees North).
@@ -107,9 +107,9 @@ def domain(self):
- An instance of :class:`plotly.graph_objs.layout.mapbox.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 mapbox subplot
@@ -144,9 +144,9 @@ def layers(self):
- A list or tuple of instances of plotly.graph_objs.layout.mapbox.Layer
- A list or tuple of dicts of string/value properties that
will be passed to the Layer constructor
-
+
Supported dict properties:
-
+
below
Determines if the layer will be inserted before
the layer with the specified ID. If omitted or
@@ -277,13 +277,13 @@ def layerdefaults(self):
When used in a template (as
layout.template.layout.mapbox.layerdefaults), sets the default
property values to use for elements of layout.mapbox.layers
-
+
The 'layerdefaults' property is an instance of Layer
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.mapbox.Layer`
- A dict of string/value properties that will be passed
to the Layer constructor
-
+
Supported dict properties:
Returns
@@ -303,7 +303,7 @@ def pitch(self):
"""
Sets the pitch angle of the map (in degrees, where 0 means
perpendicular to the surface of the map) (mapbox.pitch).
-
+
The 'pitch' property is a number and may be specified as:
- An int or float
@@ -342,7 +342,7 @@ def style(self):
styles are: basic, streets, outdoors, light, dark, satellite,
satellite-streets Mapbox style URLs are of the form:
mapbox://mapbox.mapbox--
-
+
The 'style' property accepts values of any type
Returns
@@ -363,7 +363,7 @@ def uirevision(self):
Controls persistence of user-driven changes in the view:
`center`, `zoom`, `bearing`, `pitch`. Defaults to
`layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -382,7 +382,7 @@ def uirevision(self, val):
def zoom(self):
"""
Sets the zoom level of the map (mapbox.zoom).
-
+
The 'zoom' property is a number and may be specified as:
- An int or float
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Mapbox object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_margin.py b/packages/python/plotly/plotly/graph_objs/layout/_margin.py
index 5167cb7a8af..8973d1d6bcc 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_margin.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_margin.py
@@ -18,7 +18,7 @@ def autoexpand(self):
Turns on/off margin expansion computations. Legends, colorbars,
updatemenus, sliders, axis rangeselector and rangeslider are
allowed to push the margins by defaults.
-
+
The 'autoexpand' property must be specified as a bool
(either True, or False)
@@ -38,7 +38,7 @@ def autoexpand(self, val):
def b(self):
"""
Sets the bottom margin (in px).
-
+
The 'b' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -58,7 +58,7 @@ def b(self, val):
def l(self):
"""
Sets the left margin (in px).
-
+
The 'l' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -79,7 +79,7 @@ def pad(self):
"""
Sets the amount of padding (in px) between the plotting area
and the axis lines
-
+
The 'pad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -99,7 +99,7 @@ def pad(self, val):
def r(self):
"""
Sets the right margin (in px).
-
+
The 'r' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -119,7 +119,7 @@ def r(self, val):
def t(self):
"""
Sets the top margin (in px).
-
+
The 't' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -169,7 +169,7 @@ def __init__(
):
"""
Construct a new Margin object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_modebar.py b/packages/python/plotly/plotly/graph_objs/layout/_modebar.py
index 3bf8c3d213d..ed27ca9885b 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_modebar.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_modebar.py
@@ -17,7 +17,7 @@ def activecolor(self):
"""
Sets the color of the active or hovered on icons in the
modebar.
-
+
The 'activecolor' 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)')
@@ -76,7 +76,7 @@ def activecolor(self, val):
def bgcolor(self):
"""
Sets the background color of the modebar.
-
+
The '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)')
@@ -135,7 +135,7 @@ def bgcolor(self, val):
def color(self):
"""
Sets the color of the icons in the modebar.
-
+
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)')
@@ -194,7 +194,7 @@ def color(self, val):
def orientation(self):
"""
Sets the orientation of the modebar.
-
+
The 'orientation' property is an enumeration that may be specified as:
- One of the following enumeration values:
['v', 'h']
@@ -218,7 +218,7 @@ def uirevision(self):
modebar, including `hovermode`, `dragmode`, and `showspikes` at
both the root level and inside subplots. Defaults to
`layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -264,7 +264,7 @@ def __init__(
):
"""
Construct a new Modebar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_newshape.py b/packages/python/plotly/plotly/graph_objs/layout/_newshape.py
index 9df3fb7b5f9..14e27dbc907 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_newshape.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_newshape.py
@@ -28,7 +28,7 @@ def drawdirection(self):
lines in any direction. "ortho" limits the draw to be either
horizontal or vertical. "horizontal" allows horizontal extend.
"vertical" allows vertical extend.
-
+
The 'drawdirection' property is an enumeration that may be specified as:
- One of the following enumeration values:
['ortho', 'horizontal', 'vertical', 'diagonal']
@@ -52,7 +52,7 @@ def fillcolor(self):
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.
-
+
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)')
@@ -113,7 +113,7 @@ def fillrule(self):
Determines the path's interior. For more info please visit
https://developer.mozilla.org/en-
US/docs/Web/SVG/Attribute/fill-rule
-
+
The 'fillrule' property is an enumeration that may be specified as:
- One of the following enumeration values:
['evenodd', 'nonzero']
@@ -134,7 +134,7 @@ def fillrule(self, val):
def layer(self):
"""
Specifies whether new shapes are drawn below or above traces.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['below', 'above']
@@ -159,9 +159,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.layout.newshape.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color. By default uses either
dark grey or white to increase contrast with
@@ -190,7 +190,7 @@ def line(self, val):
def opacity(self):
"""
Sets the opacity of new shapes.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -250,7 +250,7 @@ def __init__(
):
"""
Construct a new Newshape object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_polar.py b/packages/python/plotly/plotly/graph_objs/layout/_polar.py
index 104d3e7cff0..cb9cf0dc491 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_polar.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_polar.py
@@ -31,9 +31,9 @@ def angularaxis(self):
- An instance of :class:`plotly.graph_objs.layout.polar.AngularAxis`
- A dict of string/value properties that will be passed
to the AngularAxis constructor
-
+
Supported dict properties:
-
+
categoryarray
Sets the order in which categories on this axis
appear. Only has an effect if `categoryorder`
@@ -303,7 +303,7 @@ def bargap(self):
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.
-
+
The 'bargap' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -327,7 +327,7 @@ def barmode(self):
top of one another With "overlay", the bars are plotted over
one another, you might need to an "opacity" to see multiple
bars.
-
+
The 'barmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['stack', 'overlay']
@@ -348,7 +348,7 @@ def barmode(self, val):
def bgcolor(self):
"""
Set the background color of the subplot
-
+
The '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)')
@@ -411,9 +411,9 @@ def domain(self):
- An instance of :class:`plotly.graph_objs.layout.polar.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 polar subplot
@@ -449,7 +449,7 @@ def gridshape(self):
"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).
-
+
The 'gridshape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['circular', 'linear']
@@ -471,7 +471,7 @@ def hole(self):
"""
Sets the fraction of the radius to cut out of the polar
subplot.
-
+
The 'hole' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -495,9 +495,9 @@ def radialaxis(self):
- An instance of :class:`plotly.graph_objs.layout.polar.RadialAxis`
- A dict of string/value properties that will be passed
to the RadialAxis constructor
-
+
Supported dict properties:
-
+
angle
Sets the angle (in degrees) from which the
radial axis is drawn. Note that by default,
@@ -795,22 +795,22 @@ def radialaxis(self, val):
@property
def sector(self):
"""
- 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.
-
- The 'sector' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'sector[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'sector[1]' property is a number and may be specified as:
- - An int or float
+ 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.
- Returns
- -------
- list
+ The 'sector' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'sector[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'sector[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["sector"]
@@ -826,7 +826,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis attributes,
if not overridden in the individual axes. Defaults to
`layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -905,7 +905,7 @@ def __init__(
):
"""
Construct a new Polar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_radialaxis.py b/packages/python/plotly/plotly/graph_objs/layout/_radialaxis.py
index fa32796a2a2..7cf27bea37b 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_radialaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_radialaxis.py
@@ -27,20 +27,20 @@ class RadialAxis(_BaseLayoutHierarchyType):
@property
def domain(self):
"""
- Polar chart subplots are not supported yet. This key has
- currently no effect.
-
- The 'domain' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'domain[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'domain[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Polar chart subplots are not supported yet. This key has
+ currently no effect.
- Returns
- -------
- list
+ The 'domain' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'domain[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'domain[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["domain"]
@@ -55,7 +55,7 @@ def endpadding(self):
"""
Legacy polar charts are deprecated! Please switch to "polar"
subplots.
-
+
The 'endpadding' property is a number and may be specified as:
- An int or float
@@ -77,7 +77,7 @@ def orientation(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the orientation (an angle with respect to the
origin) of the radial axis.
-
+
The 'orientation' property is a number and may be specified as:
- An int or float
@@ -96,20 +96,20 @@ def orientation(self, val):
@property
def range(self):
"""
- Legacy polar charts are deprecated! Please switch to "polar"
- subplots. Defines the start and end point of this radial axis.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'range[1]' property is a number and may be specified as:
- - An int or float
+ Legacy polar charts are deprecated! Please switch to "polar"
+ subplots. Defines the start and end point of this radial axis.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'range[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -125,7 +125,7 @@ def showline(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Determines whether or not the line bounding this
radial axis will be shown on the figure.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -147,7 +147,7 @@ def showticklabels(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Determines whether or not the radial axis ticks will
feature tick labels.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -168,7 +168,7 @@ def tickcolor(self):
"""
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the color of the tick lines on this radial axis.
-
+
The 'tickcolor' 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)')
@@ -229,7 +229,7 @@ def ticklen(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the length of the tick lines on this radial
axis.
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -251,7 +251,7 @@ def tickorientation(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the orientation (from the paper perspective) of
the radial axis tick labels.
-
+
The 'tickorientation' property is an enumeration that may be specified as:
- One of the following enumeration values:
['horizontal', 'vertical']
@@ -274,7 +274,7 @@ def ticksuffix(self):
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Sets the length of the tick lines on this radial
axis.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -296,7 +296,7 @@ def visible(self):
"""
Legacy polar charts are deprecated! Please switch to "polar"
subplots. Determines whether or not this axis will be visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -377,7 +377,7 @@ def __init__(
):
"""
Construct a new RadialAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_scene.py b/packages/python/plotly/plotly/graph_objs/layout/_scene.py
index 06daa703267..69ff6515997 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_scene.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_scene.py
@@ -34,9 +34,9 @@ def annotations(self):
- A list or tuple of instances of plotly.graph_objs.layout.scene.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`
@@ -233,13 +233,13 @@ def annotationdefaults(self):
layout.template.layout.scene.annotationdefaults), sets the
default property values to use for elements of
layout.scene.annotations
-
+
The 'annotationdefaults' property is an instance of Annotation
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.Annotation`
- A dict of string/value properties that will be passed
to the Annotation constructor
-
+
Supported dict properties:
Returns
@@ -265,7 +265,7 @@ def aspectmode(self):
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.
-
+
The 'aspectmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'cube', 'data', 'manual']
@@ -286,19 +286,19 @@ def aspectmode(self, val):
def aspectratio(self):
"""
Sets this scene's axis aspectratio.
-
+
The 'aspectratio' property is an instance of Aspectratio
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.Aspectratio`
- A dict of string/value properties that will be passed
to the Aspectratio constructor
-
+
Supported dict properties:
-
+
x
-
+
y
-
+
z
Returns
@@ -378,9 +378,9 @@ def camera(self):
- An instance of :class:`plotly.graph_objs.layout.scene.Camera`
- A dict of string/value properties that will be passed
to the Camera constructor
-
+
Supported dict properties:
-
+
center
Sets the (x,y,z) components of the 'center'
camera vector This vector determines the
@@ -422,9 +422,9 @@ def domain(self):
- An instance of :class:`plotly.graph_objs.layout.scene.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 scene subplot
@@ -455,7 +455,7 @@ def domain(self, val):
def dragmode(self):
"""
Determines the mode of drag interactions for this scene.
-
+
The 'dragmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['orbit', 'turntable', 'zoom', 'pan', False]
@@ -476,7 +476,7 @@ def dragmode(self, val):
def hovermode(self):
"""
Determines the mode of hover interactions for this scene.
-
+
The 'hovermode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['closest', False]
@@ -498,7 +498,7 @@ def uirevision(self):
"""
Controls persistence of user-driven changes in camera
attributes. Defaults to `layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -521,9 +521,9 @@ def xaxis(self):
- An instance of :class:`plotly.graph_objs.layout.scene.XAxis`
- A dict of string/value properties that will be passed
to the XAxis constructor
-
+
Supported dict properties:
-
+
autorange
Determines whether or not the range of this
axis is computed in relation to the input data.
@@ -836,9 +836,9 @@ def yaxis(self):
- An instance of :class:`plotly.graph_objs.layout.scene.YAxis`
- A dict of string/value properties that will be passed
to the YAxis constructor
-
+
Supported dict properties:
-
+
autorange
Determines whether or not the range of this
axis is computed in relation to the input data.
@@ -1151,9 +1151,9 @@ def zaxis(self):
- An instance of :class:`plotly.graph_objs.layout.scene.ZAxis`
- A dict of string/value properties that will be passed
to the ZAxis constructor
-
+
Supported dict properties:
-
+
autorange
Determines whether or not the range of this
axis is computed in relation to the input data.
@@ -1531,7 +1531,7 @@ def __init__(
):
"""
Construct a new Scene object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_shape.py b/packages/python/plotly/plotly/graph_objs/layout/_shape.py
index 1882ecb3085..5757a8072ca 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_shape.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_shape.py
@@ -40,7 +40,7 @@ def editable(self):
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`.
-
+
The 'editable' property must be specified as a bool
(either True, or False)
@@ -61,7 +61,7 @@ def fillcolor(self):
"""
Sets the color filling the shape's interior. Only applies to
closed shapes.
-
+
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)')
@@ -123,7 +123,7 @@ def fillrule(self):
interior. For more info please visit
https://developer.mozilla.org/en-
US/docs/Web/SVG/Attribute/fill-rule
-
+
The 'fillrule' property is an enumeration that may be specified as:
- One of the following enumeration values:
['evenodd', 'nonzero']
@@ -144,7 +144,7 @@ def fillrule(self, val):
def layer(self):
"""
Specifies whether shapes are drawn below or above traces.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['below', 'above']
@@ -169,9 +169,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.layout.shape.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color.
dash
@@ -204,7 +204,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -225,7 +225,7 @@ def name(self, val):
def opacity(self):
"""
Sets the opacity of the shape.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -263,7 +263,7 @@ def path(self):
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
-
+
The 'path' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -291,7 +291,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -320,7 +320,7 @@ def type(self):
(`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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['circle', 'rect', 'path', 'line']
@@ -341,7 +341,7 @@ def type(self, val):
def visible(self):
"""
Determines whether or not this shape is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -362,7 +362,7 @@ def x0(self):
"""
Sets the shape's starting x position. See `type` and
`xsizemode` for more info.
-
+
The 'x0' property accepts values of any type
Returns
@@ -382,7 +382,7 @@ def x1(self):
"""
Sets the shape's end x position. See `type` and `xsizemode` for
more info.
-
+
The 'x1' property accepts values of any type
Returns
@@ -405,7 +405,7 @@ def xanchor(self):
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".
-
+
The 'xanchor' property accepts values of any type
Returns
@@ -437,7 +437,7 @@ def xref(self):
"log", then you must take the log of your desired range. If the
axis `type` is "date", then you must convert the date to unix
time in milliseconds.
-
+
The 'xref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['paper']
@@ -467,7 +467,7 @@ def xsizemode(self):
`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.
-
+
The 'xsizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['scaled', 'pixel']
@@ -489,7 +489,7 @@ def y0(self):
"""
Sets the shape's starting y position. See `type` and
`ysizemode` for more info.
-
+
The 'y0' property accepts values of any type
Returns
@@ -509,7 +509,7 @@ def y1(self):
"""
Sets the shape's end y position. See `type` and `ysizemode` for
more info.
-
+
The 'y1' property accepts values of any type
Returns
@@ -532,7 +532,7 @@ def yanchor(self):
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".
-
+
The 'yanchor' property accepts values of any type
Returns
@@ -561,7 +561,7 @@ def yref(self):
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.
-
+
The 'yref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['paper']
@@ -591,7 +591,7 @@ def ysizemode(self):
`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.
-
+
The 'ysizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['scaled', 'pixel']
@@ -796,7 +796,7 @@ def __init__(
):
"""
Construct a new Shape object
-
+
Parameters
----------
arg
@@ -979,8 +979,8 @@ def __init__(
else:
raise ValueError(
"""\
-The first argument to the plotly.graph_objs.layout.Shape
-constructor must be a dict or
+The first argument to the plotly.graph_objs.layout.Shape
+constructor must be a dict or
an instance of :class:`plotly.graph_objs.layout.Shape`"""
)
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_slider.py b/packages/python/plotly/plotly/graph_objs/layout/_slider.py
index faf24bbffab..4f1b7b54773 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_slider.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_slider.py
@@ -42,7 +42,7 @@ def active(self):
"""
Determines which button (by index starting from 0) is
considered active.
-
+
The 'active' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -62,7 +62,7 @@ def active(self, val):
def activebgcolor(self):
"""
Sets the background color of the slider grip while dragging.
-
+
The 'activebgcolor' 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)')
@@ -121,7 +121,7 @@ def activebgcolor(self, val):
def bgcolor(self):
"""
Sets the background color of the slider.
-
+
The '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)')
@@ -180,7 +180,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the color of the border enclosing the slider.
-
+
The 'bordercolor' 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)')
@@ -239,7 +239,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) of the border enclosing the slider.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -263,9 +263,9 @@ def currentvalue(self):
- An instance of :class:`plotly.graph_objs.layout.slider.Currentvalue`
- A dict of string/value properties that will be passed
to the Currentvalue constructor
-
+
Supported dict properties:
-
+
font
Sets the font of the current value label text.
offset
@@ -300,17 +300,17 @@ def currentvalue(self, val):
def font(self):
"""
Sets the font of the slider step labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.slider.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
@@ -348,7 +348,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -369,7 +369,7 @@ def lenmode(self):
"""
Determines whether this slider length is set in units of plot
"fraction" or in *pixels. Use `len` to set the value.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -390,7 +390,7 @@ def lenmode(self, val):
def minorticklen(self):
"""
Sets the length in pixels of minor step tick marks
-
+
The 'minorticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -416,7 +416,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -437,15 +437,15 @@ def name(self, val):
def pad(self):
"""
Set the padding of the slider component along each side.
-
+
The 'pad' property is an instance of Pad
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.slider.Pad`
- A dict of string/value properties that will be passed
to the Pad constructor
-
+
Supported dict properties:
-
+
b
The amount of padding (in px) along the bottom
of the component.
@@ -479,9 +479,9 @@ def steps(self):
- A list or tuple of instances of plotly.graph_objs.layout.slider.Step
- A list or tuple of dicts of string/value properties that
will be passed to the Step constructor
-
+
Supported dict properties:
-
+
args
Sets the arguments values to be passed to the
Plotly method set in `method` on slide.
@@ -552,13 +552,13 @@ def stepdefaults(self):
When used in a template (as
layout.template.layout.slider.stepdefaults), sets the default
property values to use for elements of layout.slider.steps
-
+
The 'stepdefaults' property is an instance of Step
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.slider.Step`
- A dict of string/value properties that will be passed
to the Step constructor
-
+
Supported dict properties:
Returns
@@ -584,7 +584,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -605,7 +605,7 @@ def templateitemname(self, val):
def tickcolor(self):
"""
Sets the color of the border enclosing the slider.
-
+
The 'tickcolor' 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)')
@@ -664,7 +664,7 @@ def tickcolor(self, val):
def ticklen(self):
"""
Sets the length in pixels of step tick marks
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -684,7 +684,7 @@ def ticklen(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -708,9 +708,9 @@ def transition(self):
- An instance of :class:`plotly.graph_objs.layout.slider.Transition`
- A dict of string/value properties that will be passed
to the Transition constructor
-
+
Supported dict properties:
-
+
duration
Sets the duration of the slider transition
easing
@@ -733,7 +733,7 @@ def transition(self, val):
def visible(self):
"""
Determines whether or not the slider is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -753,7 +753,7 @@ def visible(self, val):
def x(self):
"""
Sets the x position (in normalized coordinates) of the slider.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -775,7 +775,7 @@ def xanchor(self):
Sets the slider's horizontal position anchor. This anchor binds
the `x` position to the "left", "center" or "right" of the
range selector.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'left', 'center', 'right']
@@ -796,7 +796,7 @@ def xanchor(self, val):
def y(self):
"""
Sets the y position (in normalized coordinates) of the slider.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -818,7 +818,7 @@ def yanchor(self):
Sets the slider's vertical position anchor This anchor binds
the `y` position to the "top", "middle" or "bottom" of the
range selector.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'top', 'middle', 'bottom']
@@ -955,7 +955,7 @@ def __init__(
):
"""
Construct a new Slider object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_template.py b/packages/python/plotly/plotly/graph_objs/layout/_template.py
index 83c9b684daf..8f66895c786 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_template.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_template.py
@@ -20,9 +20,9 @@ def data(self):
- An instance of :class:`plotly.graph_objs.layout.template.Data`
- A dict of string/value properties that will be passed
to the Data constructor
-
+
Supported dict properties:
-
+
area
A tuple of :class:`plotly.graph_objects.Area`
instances or dicts with compatible properties
@@ -217,7 +217,7 @@ def layout(self):
- 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:
Returns
@@ -246,7 +246,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, data=None, layout=None, **kwargs):
"""
Construct a new Template object
-
+
Default attributes to be applied to the plot. This should be a
dict with format: `{'layout': layoutTemplate, 'data':
{trace_type: [traceTemplate, ...], ...}}` where
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_ternary.py b/packages/python/plotly/plotly/graph_objs/layout/_ternary.py
index 0fee1904775..a01a690e282 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_ternary.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_ternary.py
@@ -20,9 +20,9 @@ def aaxis(self):
- An instance of :class:`plotly.graph_objs.layout.ternary.Aaxis`
- A dict of string/value properties that will be passed
to the Aaxis constructor
-
+
Supported dict properties:
-
+
color
Sets default for all colors associated with
this axis all at once: line, font, tick, and
@@ -252,9 +252,9 @@ def baxis(self):
- An instance of :class:`plotly.graph_objs.layout.ternary.Baxis`
- A dict of string/value properties that will be passed
to the Baxis constructor
-
+
Supported dict properties:
-
+
color
Sets default for all colors associated with
this axis all at once: line, font, tick, and
@@ -480,7 +480,7 @@ def baxis(self, val):
def bgcolor(self):
"""
Set the background color of the subplot
-
+
The '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)')
@@ -543,9 +543,9 @@ def caxis(self):
- An instance of :class:`plotly.graph_objs.layout.ternary.Caxis`
- A dict of string/value properties that will be passed
to the Caxis constructor
-
+
Supported dict properties:
-
+
color
Sets default for all colors associated with
this axis all at once: line, font, tick, and
@@ -775,9 +775,9 @@ def domain(self):
- An instance of :class:`plotly.graph_objs.layout.ternary.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 ternary
@@ -809,7 +809,7 @@ def sum(self):
"""
The number each triplet should sum to, and the maximum range of
each axis
-
+
The 'sum' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -831,7 +831,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis `min` and
`title`, if not overridden in the individual axes. Defaults to
`layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -886,7 +886,7 @@ def __init__(
):
"""
Construct a new Ternary object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_title.py b/packages/python/plotly/plotly/graph_objs/layout/_title.py
index ab760cdc919..55d23c3c5a9 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_title.py
@@ -27,17 +27,17 @@ def font(self):
"""
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
@@ -78,15 +78,15 @@ def pad(self):
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".
-
+
The 'pad' property is an instance of Pad
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.title.Pad`
- A dict of string/value properties that will be passed
to the Pad constructor
-
+
Supported dict properties:
-
+
b
The amount of padding (in px) along the bottom
of the component.
@@ -118,7 +118,7 @@ def text(self):
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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -140,7 +140,7 @@ def x(self):
"""
Sets the x position with respect to `xref` in normalized
coordinates from 0 (left) to 1 (right).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -165,7 +165,7 @@ def xanchor(self):
title's center is at x. "auto" divides `xref` by three and
calculates the `xanchor` value automatically based on the value
of `x`.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'left', 'center', 'right']
@@ -188,7 +188,7 @@ def xref(self):
Sets the container `x` refers to. "container" spans the entire
`width` of the plot. "paper" refers to the width of the
plotting area only.
-
+
The 'xref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['container', 'paper']
@@ -212,7 +212,7 @@ def y(self):
coordinates from 0 (bottom) to 1 (top). "auto" places the
baseline of the title onto the vertical center of the top
margin.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -237,7 +237,7 @@ def yanchor(self):
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`.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'top', 'middle', 'bottom']
@@ -260,7 +260,7 @@ def yref(self):
Sets the container `y` refers to. "container" spans the entire
`height` of the plot. "paper" refers to the height of the
plotting area only.
-
+
The 'yref' property is an enumeration that may be specified as:
- One of the following enumeration values:
['container', 'paper']
@@ -345,7 +345,7 @@ def __init__(
):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_transition.py b/packages/python/plotly/plotly/graph_objs/layout/_transition.py
index fb31d6ab490..4843835b1b6 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_transition.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_transition.py
@@ -17,7 +17,7 @@ def duration(self):
"""
The duration of the transition, in milliseconds. If equal to
zero, updates are synchronous.
-
+
The 'duration' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -37,7 +37,7 @@ def duration(self, val):
def easing(self):
"""
The easing function used for the transition
-
+
The 'easing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'quad', 'cubic', 'sin', 'exp', 'circle',
@@ -68,7 +68,7 @@ def ordering(self):
Determines whether the figure's layout or traces smoothly
transitions during updates that make both traces and layout
change.
-
+
The 'ordering' property is an enumeration that may be specified as:
- One of the following enumeration values:
['layout first', 'traces first']
@@ -102,7 +102,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, duration=None, easing=None, ordering=None, **kwargs):
"""
Construct a new Transition object
-
+
Sets transition options used during Plotly.react updates.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_uniformtext.py b/packages/python/plotly/plotly/graph_objs/layout/_uniformtext.py
index 4c041022592..dcc497eb7b0 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_uniformtext.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_uniformtext.py
@@ -16,7 +16,7 @@ class Uniformtext(_BaseLayoutHierarchyType):
def minsize(self):
"""
Sets the minimum text size between traces of the same type.
-
+
The 'minsize' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -43,7 +43,7 @@ def mode(self):
Please note that if the size defined by `minsize` is greater
than the font size defined by trace, then the `minsize` is
used.
-
+
The 'mode' property is an enumeration that may be specified as:
- One of the following enumeration values:
[False, 'hide', 'show']
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, minsize=None, mode=None, **kwargs):
"""
Construct a new Uniformtext object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_updatemenu.py b/packages/python/plotly/plotly/graph_objs/layout/_updatemenu.py
index e67000306eb..0f66bd26a0f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_updatemenu.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_updatemenu.py
@@ -36,7 +36,7 @@ def active(self):
"""
Determines which button (by index starting from 0) is
considered active.
-
+
The 'active' 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]
@@ -57,7 +57,7 @@ def active(self, val):
def bgcolor(self):
"""
Sets the background color of the update menu buttons.
-
+
The '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)')
@@ -116,7 +116,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the color of the border enclosing the update menu.
-
+
The 'bordercolor' 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)')
@@ -175,7 +175,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) of the border enclosing the update menu.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -199,9 +199,9 @@ def buttons(self):
- A list or tuple of instances of plotly.graph_objs.layout.updatemenu.Button
- A list or tuple of dicts of string/value properties that
will be passed to the Button constructor
-
+
Supported dict properties:
-
+
args
Sets the arguments values to be passed to the
Plotly method set in `method` on click.
@@ -275,13 +275,13 @@ def buttondefaults(self):
layout.template.layout.updatemenu.buttondefaults), sets the
default property values to use for elements of
layout.updatemenu.buttons
-
+
The 'buttondefaults' property is an instance of Button
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.updatemenu.Button`
- A dict of string/value properties that will be passed
to the Button constructor
-
+
Supported dict properties:
Returns
@@ -303,7 +303,7 @@ def direction(self):
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.
-
+
The 'direction' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'up', 'down']
@@ -324,17 +324,17 @@ def direction(self, val):
def font(self):
"""
Sets the font of the update menu button text.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.updatemenu.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
@@ -376,7 +376,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -397,15 +397,15 @@ def name(self, val):
def pad(self):
"""
Sets the padding around the buttons or dropdown menu.
-
+
The 'pad' property is an instance of Pad
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.updatemenu.Pad`
- A dict of string/value properties that will be passed
to the Pad constructor
-
+
Supported dict properties:
-
+
b
The amount of padding (in px) along the bottom
of the component.
@@ -435,7 +435,7 @@ def pad(self, val):
def showactive(self):
"""
Highlights active dropdown item or active button if true.
-
+
The 'showactive' property must be specified as a bool
(either True, or False)
@@ -462,7 +462,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -485,7 +485,7 @@ def type(self):
Determines whether the buttons are accessible via a dropdown
menu or whether the buttons are stacked horizontally or
vertically
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['dropdown', 'buttons']
@@ -506,7 +506,7 @@ def type(self, val):
def visible(self):
"""
Determines whether or not the update menu is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -527,7 +527,7 @@ def x(self):
"""
Sets the x position (in normalized coordinates) of the update
menu.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -549,7 +549,7 @@ def xanchor(self):
Sets the update menu's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the range selector.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'left', 'center', 'right']
@@ -571,7 +571,7 @@ def y(self):
"""
Sets the y position (in normalized coordinates) of the update
menu.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -593,7 +593,7 @@ def yanchor(self):
Sets the update menu's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the range selector.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'top', 'middle', 'bottom']
@@ -711,7 +711,7 @@ def __init__(
):
"""
Construct a new Updatemenu object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_xaxis.py b/packages/python/plotly/plotly/graph_objs/layout/_xaxis.py
index 11303082524..81b6bb45aaa 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_xaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_xaxis.py
@@ -97,7 +97,7 @@ def anchor(self):
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`.
-
+
The 'anchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['free']
@@ -122,7 +122,7 @@ def automargin(self):
"""
Determines whether long tick labels automatically grow the
figure margins.
-
+
The 'automargin' property must be specified as a bool
(either True, or False)
@@ -144,7 +144,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -168,7 +168,7 @@ def calendar(self):
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`
-
+
The 'calendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -194,7 +194,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -215,7 +215,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -249,7 +249,7 @@ def categoryorder(self):
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean or median of all the
values.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -278,7 +278,7 @@ def color(self):
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)')
@@ -340,7 +340,7 @@ def constrain(self):
`scaleanchor` and `scaleratio` or those of the other axis),
determines how that happens: by increasing the "range"
(default), or by decreasing the "domain".
-
+
The 'constrain' property is an enumeration that may be specified as:
- One of the following enumeration values:
['range', 'domain']
@@ -366,7 +366,7 @@ def constraintoward(self):
plot area. Options are "left", "center" (default), and "right"
for x axes, and "top", "middle" (default), and "bottom" for y
axes.
-
+
The 'constraintoward' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right', 'top', 'middle', 'bottom']
@@ -388,7 +388,7 @@ def dividercolor(self):
"""
Sets the color of the dividers Only has an effect on
"multicategory" axes.
-
+
The 'dividercolor' 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)')
@@ -448,7 +448,7 @@ def dividerwidth(self):
"""
Sets the width (in px) of the dividers Only has an effect on
"multicategory" axes.
-
+
The 'dividerwidth' property is a number and may be specified as:
- An int or float
@@ -467,19 +467,19 @@ def dividerwidth(self, val):
@property
def domain(self):
"""
- Sets the domain of this axis (in plot fraction).
-
- The 'domain' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'domain[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'domain[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the domain of this axis (in plot fraction).
- Returns
- -------
- list
+ The 'domain' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'domain[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'domain[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["domain"]
@@ -512,7 +512,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -535,7 +535,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -557,7 +557,7 @@ def fixedrange(self):
"""
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
-
+
The 'fixedrange' property must be specified as a bool
(either True, or False)
@@ -577,7 +577,7 @@ def fixedrange(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -636,7 +636,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -663,7 +663,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -689,7 +689,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['above traces', 'below traces']
@@ -710,7 +710,7 @@ def layer(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -769,7 +769,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -795,7 +795,7 @@ def matches(self):
setting axes simultaneously in both a `scaleanchor` and a
`matches` constraint is currently forbidden. Moreover, note
that matching axes must have the same `type`.
-
+
The 'matches' property is an enumeration that may be specified as:
- A string that matches one of the following regular expressions:
['^x([2-9]|[1-9][0-9]+)?( domain)?$',
@@ -843,7 +843,7 @@ def mirror(self):
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.
-
+
The 'mirror' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, 'ticks', False, 'all', 'allticks']
@@ -867,7 +867,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -892,7 +892,7 @@ def overlaying(self):
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.
-
+
The 'overlaying' property is an enumeration that may be specified as:
- One of the following enumeration values:
['free']
@@ -918,7 +918,7 @@ def position(self):
Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if `anchor` is set
to "free".
-
+
The 'position' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -937,24 +937,24 @@ def position(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -972,9 +972,9 @@ def rangebreaks(self):
- A list or tuple of instances of plotly.graph_objs.layout.xaxis.Rangebreak
- A list or tuple of dicts of string/value properties that
will be passed to the Rangebreak constructor
-
+
Supported dict properties:
-
+
bounds
Sets the lower and upper bounds of this axis
rangebreak. Can be used with `pattern`.
@@ -1046,13 +1046,13 @@ def rangebreakdefaults(self):
layout.template.layout.xaxis.rangebreakdefaults), sets the
default property values to use for elements of
layout.xaxis.rangebreaks
-
+
The 'rangebreakdefaults' property is an instance of Rangebreak
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.xaxis.Rangebreak`
- A dict of string/value properties that will be passed
to the Rangebreak constructor
-
+
Supported dict properties:
Returns
@@ -1075,7 +1075,7 @@ def rangemode(self):
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear axes.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['normal', 'tozero', 'nonnegative']
@@ -1100,9 +1100,9 @@ def rangeselector(self):
- An instance of :class:`plotly.graph_objs.layout.xaxis.Rangeselector`
- A dict of string/value properties that will be passed
to the Rangeselector constructor
-
+
Supported dict properties:
-
+
activecolor
Sets the background color of the active range
selector button.
@@ -1169,9 +1169,9 @@ def rangeslider(self):
- An instance of :class:`plotly.graph_objs.layout.xaxis.Rangeslider`
- A dict of string/value properties that will be passed
to the Rangeslider constructor
-
+
Supported dict properties:
-
+
autorange
Determines whether or not the range slider
range is computed in relation to the input
@@ -1238,7 +1238,7 @@ def scaleanchor(self):
inconsistent constraints via `scaleratio`. Note that setting
axes simultaneously in both a `scaleanchor` and a `matches`
constraint is currently forbidden.
-
+
The 'scaleanchor' property is an enumeration that may be specified as:
- A string that matches one of the following regular expressions:
['^x([2-9]|[1-9][0-9]+)?( domain)?$',
@@ -1265,7 +1265,7 @@ def scaleratio(self):
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.
-
+
The 'scaleratio' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1285,7 +1285,7 @@ def scaleratio(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -1307,7 +1307,7 @@ def showdividers(self):
Determines whether or not a dividers are drawn between the
category levels of this axis. Only has an effect on
"multicategory" axes.
-
+
The 'showdividers' property must be specified as a bool
(either True, or False)
@@ -1330,7 +1330,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1352,7 +1352,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -1372,7 +1372,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -1394,7 +1394,7 @@ def showspikes(self):
Determines whether or not spikes (aka droplines) are drawn for
this axis. Note: This only takes affect when hovermode =
closest
-
+
The 'showspikes' property must be specified as a bool
(either True, or False)
@@ -1414,7 +1414,7 @@ def showspikes(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -1437,7 +1437,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1458,7 +1458,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1480,7 +1480,7 @@ def side(self):
"""
Determines whether a x (y) axis is positioned at the "bottom"
("left") or "top" ("right") of the plotting area.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right']
@@ -1501,7 +1501,7 @@ def side(self, val):
def spikecolor(self):
"""
Sets the spike color. If undefined, will use the series color
-
+
The 'spikecolor' 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)')
@@ -1563,7 +1563,7 @@ def spikedash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'spikedash' property is a string and must be specified as:
- One of the following strings:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -1590,7 +1590,7 @@ def spikemode(self):
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
-
+
The 'spikemode' property is a flaglist and may be specified
as a string containing:
- Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters
@@ -1613,7 +1613,7 @@ def spikesnap(self):
"""
Determines whether spikelines are stuck to the cursor or to the
closest datapoints.
-
+
The 'spikesnap' property is an enumeration that may be specified as:
- One of the following enumeration values:
['data', 'cursor', 'hovered data']
@@ -1634,7 +1634,7 @@ def spikesnap(self, val):
def spikethickness(self):
"""
Sets the width (in px) of the zero line.
-
+
The 'spikethickness' property is a number and may be specified as:
- An int or float
@@ -1662,7 +1662,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -1683,7 +1683,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -1705,7 +1705,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -1764,17 +1764,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.xaxis.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
@@ -1817,7 +1817,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1842,9 +1842,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.xaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1898,13 +1898,13 @@ def tickformatstopdefaults(self):
layout.template.layout.xaxis.tickformatstopdefaults), sets the
default property values to use for elements of
layout.xaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.xaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1926,7 +1926,7 @@ def ticklabelmode(self):
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.
-
+
The 'ticklabelmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['instant', 'period']
@@ -1947,7 +1947,7 @@ def ticklabelmode(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1973,7 +1973,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -1994,7 +1994,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -2017,7 +2017,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -2042,7 +2042,7 @@ def tickson(self):
`type` "category" or "multicategory". When set to "boundaries",
ticks and grid lines are drawn half a category to the
left/bottom of labels.
-
+
The 'tickson' property is an enumeration that may be specified as:
- One of the following enumeration values:
['labels', 'boundaries']
@@ -2063,7 +2063,7 @@ def tickson(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -2086,7 +2086,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -2106,7 +2106,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -2127,7 +2127,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -2147,7 +2147,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -2167,7 +2167,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -2191,9 +2191,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.xaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -2235,17 +2235,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.xaxis.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
@@ -2267,7 +2267,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -2283,7 +2283,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'log', 'date', 'category',
@@ -2307,7 +2307,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis `range`,
`autorange`, and `title` if in `editable: true` configuration.
Defaults to `layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -2328,7 +2328,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -2350,7 +2350,7 @@ def zeroline(self):
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.
-
+
The 'zeroline' property must be specified as a bool
(either True, or False)
@@ -2370,7 +2370,7 @@ def zeroline(self, val):
def zerolinecolor(self):
"""
Sets the line color of the zero line.
-
+
The 'zerolinecolor' 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)')
@@ -2429,7 +2429,7 @@ def zerolinecolor(self, val):
def zerolinewidth(self):
"""
Sets the width (in px) of the zero line.
-
+
The 'zerolinewidth' property is a number and may be specified as:
- An int or float
@@ -2932,7 +2932,7 @@ def __init__(
):
"""
Construct a new XAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/_yaxis.py b/packages/python/plotly/plotly/graph_objs/layout/_yaxis.py
index f77195038d1..db534ca93b7 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/_yaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/_yaxis.py
@@ -95,7 +95,7 @@ def anchor(self):
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`.
-
+
The 'anchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['free']
@@ -120,7 +120,7 @@ def automargin(self):
"""
Determines whether long tick labels automatically grow the
figure margins.
-
+
The 'automargin' property must be specified as a bool
(either True, or False)
@@ -142,7 +142,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -166,7 +166,7 @@ def calendar(self):
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`
-
+
The 'calendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -192,7 +192,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -213,7 +213,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -247,7 +247,7 @@ def categoryorder(self):
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean or median of all the
values.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -276,7 +276,7 @@ def color(self):
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)')
@@ -338,7 +338,7 @@ def constrain(self):
`scaleanchor` and `scaleratio` or those of the other axis),
determines how that happens: by increasing the "range"
(default), or by decreasing the "domain".
-
+
The 'constrain' property is an enumeration that may be specified as:
- One of the following enumeration values:
['range', 'domain']
@@ -364,7 +364,7 @@ def constraintoward(self):
plot area. Options are "left", "center" (default), and "right"
for x axes, and "top", "middle" (default), and "bottom" for y
axes.
-
+
The 'constraintoward' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right', 'top', 'middle', 'bottom']
@@ -386,7 +386,7 @@ def dividercolor(self):
"""
Sets the color of the dividers Only has an effect on
"multicategory" axes.
-
+
The 'dividercolor' 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)')
@@ -446,7 +446,7 @@ def dividerwidth(self):
"""
Sets the width (in px) of the dividers Only has an effect on
"multicategory" axes.
-
+
The 'dividerwidth' property is a number and may be specified as:
- An int or float
@@ -465,19 +465,19 @@ def dividerwidth(self, val):
@property
def domain(self):
"""
- Sets the domain of this axis (in plot fraction).
-
- The 'domain' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'domain[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'domain[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the domain of this axis (in plot fraction).
- Returns
- -------
- list
+ The 'domain' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'domain[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'domain[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["domain"]
@@ -510,7 +510,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -533,7 +533,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -555,7 +555,7 @@ def fixedrange(self):
"""
Determines whether or not this axis is zoom-able. If true, then
zoom is disabled.
-
+
The 'fixedrange' property must be specified as a bool
(either True, or False)
@@ -575,7 +575,7 @@ def fixedrange(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -634,7 +634,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -661,7 +661,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -687,7 +687,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['above traces', 'below traces']
@@ -708,7 +708,7 @@ def layer(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -767,7 +767,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -793,7 +793,7 @@ def matches(self):
setting axes simultaneously in both a `scaleanchor` and a
`matches` constraint is currently forbidden. Moreover, note
that matching axes must have the same `type`.
-
+
The 'matches' property is an enumeration that may be specified as:
- A string that matches one of the following regular expressions:
['^x([2-9]|[1-9][0-9]+)?( domain)?$',
@@ -841,7 +841,7 @@ def mirror(self):
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.
-
+
The 'mirror' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, 'ticks', False, 'all', 'allticks']
@@ -865,7 +865,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -890,7 +890,7 @@ def overlaying(self):
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.
-
+
The 'overlaying' property is an enumeration that may be specified as:
- One of the following enumeration values:
['free']
@@ -916,7 +916,7 @@ def position(self):
Sets the position of this axis in the plotting space (in
normalized coordinates). Only has an effect if `anchor` is set
to "free".
-
+
The 'position' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -935,24 +935,24 @@ def position(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -970,9 +970,9 @@ def rangebreaks(self):
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Rangebreak
- A list or tuple of dicts of string/value properties that
will be passed to the Rangebreak constructor
-
+
Supported dict properties:
-
+
bounds
Sets the lower and upper bounds of this axis
rangebreak. Can be used with `pattern`.
@@ -1044,13 +1044,13 @@ def rangebreakdefaults(self):
layout.template.layout.yaxis.rangebreakdefaults), sets the
default property values to use for elements of
layout.yaxis.rangebreaks
-
+
The 'rangebreakdefaults' property is an instance of Rangebreak
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Rangebreak`
- A dict of string/value properties that will be passed
to the Rangebreak constructor
-
+
Supported dict properties:
Returns
@@ -1073,7 +1073,7 @@ def rangemode(self):
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear axes.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['normal', 'tozero', 'nonnegative']
@@ -1109,7 +1109,7 @@ def scaleanchor(self):
inconsistent constraints via `scaleratio`. Note that setting
axes simultaneously in both a `scaleanchor` and a `matches`
constraint is currently forbidden.
-
+
The 'scaleanchor' property is an enumeration that may be specified as:
- A string that matches one of the following regular expressions:
['^x([2-9]|[1-9][0-9]+)?( domain)?$',
@@ -1136,7 +1136,7 @@ def scaleratio(self):
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.
-
+
The 'scaleratio' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1156,7 +1156,7 @@ def scaleratio(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -1178,7 +1178,7 @@ def showdividers(self):
Determines whether or not a dividers are drawn between the
category levels of this axis. Only has an effect on
"multicategory" axes.
-
+
The 'showdividers' property must be specified as a bool
(either True, or False)
@@ -1201,7 +1201,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1223,7 +1223,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -1243,7 +1243,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -1265,7 +1265,7 @@ def showspikes(self):
Determines whether or not spikes (aka droplines) are drawn for
this axis. Note: This only takes affect when hovermode =
closest
-
+
The 'showspikes' property must be specified as a bool
(either True, or False)
@@ -1285,7 +1285,7 @@ def showspikes(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -1308,7 +1308,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1329,7 +1329,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -1351,7 +1351,7 @@ def side(self):
"""
Determines whether a x (y) axis is positioned at the "bottom"
("left") or "top" ("right") of the plotting area.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom', 'left', 'right']
@@ -1372,7 +1372,7 @@ def side(self, val):
def spikecolor(self):
"""
Sets the spike color. If undefined, will use the series color
-
+
The 'spikecolor' 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)')
@@ -1434,7 +1434,7 @@ def spikedash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'spikedash' property is a string and must be specified as:
- One of the following strings:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -1461,7 +1461,7 @@ def spikemode(self):
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
-
+
The 'spikemode' property is a flaglist and may be specified
as a string containing:
- Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters
@@ -1484,7 +1484,7 @@ def spikesnap(self):
"""
Determines whether spikelines are stuck to the cursor or to the
closest datapoints.
-
+
The 'spikesnap' property is an enumeration that may be specified as:
- One of the following enumeration values:
['data', 'cursor', 'hovered data']
@@ -1505,7 +1505,7 @@ def spikesnap(self, val):
def spikethickness(self):
"""
Sets the width (in px) of the zero line.
-
+
The 'spikethickness' property is a number and may be specified as:
- An int or float
@@ -1533,7 +1533,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -1554,7 +1554,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -1576,7 +1576,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -1635,17 +1635,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.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
@@ -1688,7 +1688,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1713,9 +1713,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.yaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1769,13 +1769,13 @@ def tickformatstopdefaults(self):
layout.template.layout.yaxis.tickformatstopdefaults), sets the
default property values to use for elements of
layout.yaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1797,7 +1797,7 @@ def ticklabelmode(self):
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.
-
+
The 'ticklabelmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['instant', 'period']
@@ -1818,7 +1818,7 @@ def ticklabelmode(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1844,7 +1844,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -1865,7 +1865,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1888,7 +1888,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -1913,7 +1913,7 @@ def tickson(self):
`type` "category" or "multicategory". When set to "boundaries",
ticks and grid lines are drawn half a category to the
left/bottom of labels.
-
+
The 'tickson' property is an enumeration that may be specified as:
- One of the following enumeration values:
['labels', 'boundaries']
@@ -1934,7 +1934,7 @@ def tickson(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1957,7 +1957,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1977,7 +1977,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1998,7 +1998,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -2018,7 +2018,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -2038,7 +2038,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -2062,9 +2062,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.yaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -2106,17 +2106,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.yaxis.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
@@ -2138,7 +2138,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -2154,7 +2154,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'log', 'date', 'category',
@@ -2178,7 +2178,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis `range`,
`autorange`, and `title` if in `editable: true` configuration.
Defaults to `layout.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -2199,7 +2199,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -2221,7 +2221,7 @@ def zeroline(self):
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.
-
+
The 'zeroline' property must be specified as a bool
(either True, or False)
@@ -2241,7 +2241,7 @@ def zeroline(self, val):
def zerolinecolor(self):
"""
Sets the line color of the zero line.
-
+
The 'zerolinecolor' 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)')
@@ -2300,7 +2300,7 @@ def zerolinecolor(self, val):
def zerolinewidth(self):
"""
Sets the width (in px) of the zero line.
-
+
The 'zerolinewidth' property is a number and may be specified as:
- An int or float
@@ -2795,7 +2795,7 @@ def __init__(
):
"""
Construct a new YAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/annotation/_font.py b/packages/python/plotly/plotly/graph_objs/layout/annotation/_font.py
index 47bf55a08ba..7b03a9d38e8 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/annotation/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/annotation/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the annotation text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/annotation/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/layout/annotation/_hoverlabel.py
index f6d19fe33c9..da8cdb063e0 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/annotation/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/annotation/_hoverlabel.py
@@ -18,7 +18,7 @@ def bgcolor(self):
Sets the background color of the hover label. By default uses
the annotation's `bgcolor` made opaque, or white if it was
transparent.
-
+
The '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)')
@@ -79,7 +79,7 @@ def bordercolor(self):
Sets the border color of the hover label. By default uses
either dark grey or white, for maximum contrast with
`hoverlabel.bgcolor`.
-
+
The 'bordercolor' 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)')
@@ -139,17 +139,17 @@ def font(self):
"""
Sets the hover label text font. By default uses the global
hover font and size, with color from `hoverlabel.bordercolor`.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.annotation.hoverlabel.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
@@ -201,7 +201,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/_font.py
index ab38bdeb817..e916376fa41 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/annotation/hoverlabel/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the hover label text font. By default uses the global
hover font and size, with color from `hoverlabel.bordercolor`.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/_colorbar.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/_colorbar.py
index bbc7f0abb28..43a171e9551 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseLayoutHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
lorbar.tickformatstopdefaults), sets the default property
values to use for elements of
layout.coloraxis.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.layout.coloraxis.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1556,7 +1556,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py
index 77fc64c2fa4..4470ac7aa38 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py
index 77fbfcd0294..a2dd0881d9a 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_title.py
index 47cd2609f42..72b4a16f73f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.layout.coloraxis.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py
index d8da06a9d6a..33e874b4be1 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/_center.py b/packages/python/plotly/plotly/graph_objs/layout/geo/_center.py
index 5ef0dcd89e9..6cbdb2816e8 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/geo/_center.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/geo/_center.py
@@ -18,7 +18,7 @@ def lat(self):
Sets the latitude of the map's center. For all projection
types, the map's latitude center lies at the middle of the
latitude range by default.
-
+
The 'lat' property is a number and may be specified as:
- An int or float
@@ -41,7 +41,7 @@ def lon(self):
longitude center lies at the middle of the longitude range for
scoped projection and above `projection.rotation.lon`
otherwise.
-
+
The 'lon' property is a number and may be specified as:
- An int or float
@@ -74,7 +74,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, lat=None, lon=None, **kwargs):
"""
Construct a new Center object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/_domain.py b/packages/python/plotly/plotly/graph_objs/layout/geo/_domain.py
index 660385eb9b9..1a7566a39a6 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/geo/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/geo/_domain.py
@@ -20,7 +20,7 @@ def column(self):
constrained by domain. In general, when `projection.scale` is
set to 1. a map will fit either its x or y domain, but not
both.
-
+
The 'column' 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]
@@ -45,7 +45,7 @@ def row(self):
constrained by domain. In general, when `projection.scale` is
set to 1. a map will fit either its x or y domain, but not
both.
-
+
The 'row' 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]
@@ -65,22 +65,22 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this geo subplot (in plot
- fraction). Note that geo subplots are constrained by domain. In
- general, when `projection.scale` is set to 1. a map will fit
- either its x or y domain, but not both.
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this geo subplot (in plot
+ fraction). Note that geo subplots are constrained by domain. In
+ general, when `projection.scale` is set to 1. a map will fit
+ either its x or y domain, but not both.
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -93,22 +93,22 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this geo subplot (in plot
- fraction). Note that geo subplots are constrained by domain. In
- general, when `projection.scale` is set to 1. a map will fit
- either its x or y domain, but not both.
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this geo subplot (in plot
+ fraction). Note that geo subplots are constrained by domain. In
+ general, when `projection.scale` is set to 1. a map will fit
+ either its x or y domain, but not both.
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -150,7 +150,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/_lataxis.py b/packages/python/plotly/plotly/graph_objs/layout/geo/_lataxis.py
index 4bcbeeaebb3..dc4a2d49cda 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/geo/_lataxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/geo/_lataxis.py
@@ -16,7 +16,7 @@ class Lataxis(_BaseLayoutHierarchyType):
def dtick(self):
"""
Sets the graticule's longitude/latitude tick step.
-
+
The 'dtick' property is a number and may be specified as:
- An int or float
@@ -36,7 +36,7 @@ def dtick(self, val):
def gridcolor(self):
"""
Sets the graticule's stroke color.
-
+
The 'gridcolor' 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)')
@@ -95,7 +95,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the graticule's stroke width (in px).
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -114,20 +114,20 @@ def gridwidth(self, val):
@property
def range(self):
"""
- Sets the range of this axis (in degrees), sets the map's
- clipped coordinates.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'range[1]' property is a number and may be specified as:
- - An int or float
+ Sets the range of this axis (in degrees), sets the map's
+ clipped coordinates.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'range[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -141,7 +141,7 @@ def range(self, val):
def showgrid(self):
"""
Sets whether or not graticule are shown on the map.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -161,7 +161,7 @@ def showgrid(self, val):
def tick0(self):
"""
Sets the graticule's starting tick longitude/latitude.
-
+
The 'tick0' property is a number and may be specified as:
- An int or float
@@ -208,7 +208,7 @@ def __init__(
):
"""
Construct a new Lataxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/_lonaxis.py b/packages/python/plotly/plotly/graph_objs/layout/geo/_lonaxis.py
index 27c316292c3..0f346be8a14 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/geo/_lonaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/geo/_lonaxis.py
@@ -16,7 +16,7 @@ class Lonaxis(_BaseLayoutHierarchyType):
def dtick(self):
"""
Sets the graticule's longitude/latitude tick step.
-
+
The 'dtick' property is a number and may be specified as:
- An int or float
@@ -36,7 +36,7 @@ def dtick(self, val):
def gridcolor(self):
"""
Sets the graticule's stroke color.
-
+
The 'gridcolor' 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)')
@@ -95,7 +95,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the graticule's stroke width (in px).
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -114,20 +114,20 @@ def gridwidth(self, val):
@property
def range(self):
"""
- Sets the range of this axis (in degrees), sets the map's
- clipped coordinates.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'range[1]' property is a number and may be specified as:
- - An int or float
+ Sets the range of this axis (in degrees), sets the map's
+ clipped coordinates.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'range[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -141,7 +141,7 @@ def range(self, val):
def showgrid(self):
"""
Sets whether or not graticule are shown on the map.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -161,7 +161,7 @@ def showgrid(self, val):
def tick0(self):
"""
Sets the graticule's starting tick longitude/latitude.
-
+
The 'tick0' property is a number and may be specified as:
- An int or float
@@ -208,7 +208,7 @@ def __init__(
):
"""
Construct a new Lonaxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/_projection.py b/packages/python/plotly/plotly/graph_objs/layout/geo/_projection.py
index 2ea50556c5e..bad6f65d250 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/geo/_projection.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/geo/_projection.py
@@ -15,20 +15,20 @@ class Projection(_BaseLayoutHierarchyType):
@property
def parallels(self):
"""
- For conic projection types only. Sets the parallels (tangent,
- secant) where the cone intersects the sphere.
-
- The 'parallels' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'parallels[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'parallels[1]' property is a number and may be specified as:
- - An int or float
+ For conic projection types only. Sets the parallels (tangent,
+ secant) where the cone intersects the sphere.
- Returns
- -------
- list
+ The 'parallels' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'parallels[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'parallels[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["parallels"]
@@ -46,9 +46,9 @@ def rotation(self):
- An instance of :class:`plotly.graph_objs.layout.geo.projection.Rotation`
- A dict of string/value properties that will be passed
to the Rotation constructor
-
+
Supported dict properties:
-
+
lat
Rotates the map along meridians (in degrees
North).
@@ -77,7 +77,7 @@ def scale(self):
"""
Zooms in or out on the map view. A scale of 1 corresponds to
the largest zoom level that fits the map's lon and lat ranges.
-
+
The 'scale' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -97,7 +97,7 @@ def scale(self, val):
def type(self):
"""
Sets the projection type.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['equirectangular', 'mercator', 'orthographic', 'natural
@@ -142,7 +142,7 @@ def __init__(
):
"""
Construct a new Projection object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/geo/projection/_rotation.py b/packages/python/plotly/plotly/graph_objs/layout/geo/projection/_rotation.py
index d94f81ae8d1..eca583cb2de 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/geo/projection/_rotation.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/geo/projection/_rotation.py
@@ -16,7 +16,7 @@ class Rotation(_BaseLayoutHierarchyType):
def lat(self):
"""
Rotates the map along meridians (in degrees North).
-
+
The 'lat' property is a number and may be specified as:
- An int or float
@@ -37,7 +37,7 @@ def lon(self):
"""
Rotates the map along parallels (in degrees East). Defaults to
the center of the `lonaxis.range` values.
-
+
The 'lon' property is a number and may be specified as:
- An int or float
@@ -58,7 +58,7 @@ def roll(self):
"""
Roll the map (in degrees) For example, a roll of 180 makes the
map appear upside down.
-
+
The 'roll' property is a number and may be specified as:
- An int or float
@@ -90,7 +90,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, lat=None, lon=None, roll=None, **kwargs):
"""
Construct a new Rotation object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/grid/_domain.py b/packages/python/plotly/plotly/graph_objs/layout/grid/_domain.py
index 5e15999a4a6..6b15a753686 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/grid/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/grid/_domain.py
@@ -15,21 +15,21 @@ class Domain(_BaseLayoutHierarchyType):
@property
def x(self):
"""
- Sets the horizontal domain of this grid subplot (in plot
- fraction). The first and last cells end exactly at the domain
- edges, with no grout around the edges.
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this grid subplot (in plot
+ fraction). The first and last cells end exactly at the domain
+ edges, with no grout around the edges.
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -42,21 +42,21 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this grid subplot (in plot
- fraction). The first and last cells end exactly at the domain
- edges, with no grout around the edges.
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this grid subplot (in plot
+ fraction). The first and last cells end exactly at the domain
+ edges, with no grout around the edges.
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/_font.py
index 9a4f0305e5a..057553fa375 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/hoverlabel/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the default hover label font used by all traces on the
graph.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/legend/_font.py b/packages/python/plotly/plotly/graph_objs/layout/legend/_font.py
index 0c47876f7c7..97995f0c927 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/legend/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/legend/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the font used to text the legend items.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/legend/_title.py b/packages/python/plotly/plotly/graph_objs/layout/legend/_title.py
index 1f10724431e..334fb4ebb71 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/legend/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/legend/_title.py
@@ -16,17 +16,17 @@ class Title(_BaseLayoutHierarchyType):
def font(self):
"""
Sets this legend's title font.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.legend.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
@@ -66,7 +66,7 @@ def side(self):
Defaulted to "left" with `orientation` is "v". The *top left*
options could be used to expand legend area in both x and y
sides.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'left', 'top left']
@@ -87,7 +87,7 @@ def side(self, val):
def text(self):
"""
Sets the title of the legend.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -122,7 +122,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/legend/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/legend/title/_font.py
index b8792eda172..104a769db61 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/legend/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/legend/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this legend's title font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/_center.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/_center.py
index 0fa0bd50c20..5916b856af6 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/_center.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/_center.py
@@ -16,7 +16,7 @@ class Center(_BaseLayoutHierarchyType):
def lat(self):
"""
Sets the latitude of the center of the map (in degrees North).
-
+
The 'lat' property is a number and may be specified as:
- An int or float
@@ -36,7 +36,7 @@ def lat(self, val):
def lon(self):
"""
Sets the longitude of the center of the map (in degrees East).
-
+
The 'lon' property is a number and may be specified as:
- An int or float
@@ -66,7 +66,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, lat=None, lon=None, **kwargs):
"""
Construct a new Center object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/_domain.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/_domain.py
index f687d081ef0..a25e483b6a9 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this mapbox subplot .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this mapbox subplot .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this mapbox subplot (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this mapbox subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this mapbox subplot (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this mapbox subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/_layer.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/_layer.py
index 3ecc349aabc..199993ca225 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/_layer.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/_layer.py
@@ -37,7 +37,7 @@ def below(self):
Determines if the layer will be inserted before the layer with
the specified ID. If omitted or 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
@@ -62,9 +62,9 @@ def circle(self):
- An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Circle`
- A dict of string/value properties that will be passed
to the Circle constructor
-
+
Supported dict properties:
-
+
radius
Sets the circle radius
(mapbox.layer.paint.circle-radius). Has an
@@ -92,7 +92,7 @@ def color(self):
corresponds to the fill color (mapbox.layer.paint.fill-color)
If `type` is "symbol", color corresponds to the icon color
(mapbox.layer.paint.icon-color)
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -154,7 +154,7 @@ def coordinates(self):
for the image corners listed in clockwise order: top left, top
right, bottom right, bottom left. Only has an effect for
"image" `sourcetype`.
-
+
The 'coordinates' property accepts values of any type
Returns
@@ -177,9 +177,9 @@ def fill(self):
- An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Fill`
- A dict of string/value properties that will be passed
to the Fill constructor
-
+
Supported dict properties:
-
+
outlinecolor
Sets the fill outline color
(mapbox.layer.paint.fill-outline-color). Has an
@@ -205,9 +205,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
dash
Sets the length of dashes and gaps
(mapbox.layer.paint.line-dasharray). Has an
@@ -238,7 +238,7 @@ def maxzoom(self):
Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom
levels equal to or greater than the maxzoom, the layer will be
hidden.
-
+
The 'maxzoom' property is a number and may be specified as:
- An int or float in the interval [0, 24]
@@ -259,7 +259,7 @@ def minzoom(self):
"""
Sets the minimum zoom level (mapbox.layer.minzoom). At zoom
levels less than the minzoom, the layer will be hidden.
-
+
The 'minzoom' property is a number and may be specified as:
- An int or float in the interval [0, 24]
@@ -285,7 +285,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -313,7 +313,7 @@ def opacity(self):
(mapbox.layer.paint.fill-opacity) If `type` is "symbol",
opacity corresponds to the icon/text opacity
(mapbox.layer.paint.text-opacity)
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -338,7 +338,7 @@ def source(self):
"vector" or "raster", `source` can be a URL or an array of tile
URLs. When `sourcetype` is set to "image", `source` can be a
URL to an image.
-
+
The 'source' property accepts values of any type
Returns
@@ -357,7 +357,7 @@ def source(self, val):
def sourceattribution(self):
"""
Sets the attribution for this source.
-
+
The 'sourceattribution' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -380,7 +380,7 @@ def sourcelayer(self):
Specifies the layer to use from a vector tile source
(mapbox.layer.source-layer). Required for "vector" source type
that supports multiple layers.
-
+
The 'sourcelayer' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -402,7 +402,7 @@ def sourcetype(self):
"""
Sets the source type for this layer, that is the type of the
layer data.
-
+
The 'sourcetype' property is an enumeration that may be specified as:
- One of the following enumeration values:
['geojson', 'vector', 'raster', 'image']
@@ -427,9 +427,9 @@ def symbol(self):
- An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Symbol`
- A dict of string/value properties that will be passed
to the Symbol constructor
-
+
Supported dict properties:
-
+
icon
Sets the symbol icon image
(mapbox.layer.layout.icon-image). Full list:
@@ -482,7 +482,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -510,7 +510,7 @@ def type(self):
"vector", the following values are allowed: "circle", "line",
"fill" and "symbol". With `sourcetype` set to "raster" or
`*image*`, only the "raster" value is allowed.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['circle', 'line', 'fill', 'symbol', 'raster']
@@ -531,7 +531,7 @@ def type(self, val):
def visible(self):
"""
Determines whether this layer is displayed
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -675,7 +675,7 @@ def __init__(
):
"""
Construct a new Layer object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_circle.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_circle.py
index 94fe7adb6f1..a7fae12f6b6 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_circle.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_circle.py
@@ -17,7 +17,7 @@ def radius(self):
"""
Sets the circle radius (mapbox.layer.paint.circle-radius). Has
an effect only when `type` is set to "circle".
-
+
The 'radius' property is a number and may be specified as:
- An int or float
@@ -45,7 +45,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, radius=None, **kwargs):
"""
Construct a new Circle object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_fill.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_fill.py
index 24422422c84..96a5bc63c4d 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_fill.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_fill.py
@@ -17,7 +17,7 @@ def outlinecolor(self):
"""
Sets the fill outline color (mapbox.layer.paint.fill-outline-
color). Has an effect only when `type` is set to "fill".
-
+
The 'outlinecolor' 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)')
@@ -84,7 +84,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, outlinecolor=None, **kwargs):
"""
Construct a new Fill object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_line.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_line.py
index 1aec91c892f..5b9885f856b 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_line.py
@@ -17,7 +17,7 @@ def dash(self):
"""
Sets the length of dashes and gaps (mapbox.layer.paint.line-
dasharray). Has an effect only when `type` is set to "line".
-
+
The 'dash' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -37,7 +37,7 @@ def dash(self, val):
def dashsrc(self):
"""
Sets the source reference on Chart Studio Cloud for dash .
-
+
The 'dashsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -58,7 +58,7 @@ def width(self):
"""
Sets the line width (mapbox.layer.paint.line-width). Has an
effect only when `type` is set to "line".
-
+
The 'width' property is a number and may be specified as:
- An int or float
@@ -92,7 +92,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, dash=None, dashsrc=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_symbol.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_symbol.py
index a097c9c41c4..ca240f5d2c3 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_symbol.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/_symbol.py
@@ -17,7 +17,7 @@ def icon(self):
"""
Sets the symbol icon image (mapbox.layer.layout.icon-image).
Full list: https://www.mapbox.com/maki-icons/
-
+
The 'icon' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -39,7 +39,7 @@ def iconsize(self):
"""
Sets the symbol icon size (mapbox.layer.layout.icon-size). Has
an effect only when `type` is set to "symbol".
-
+
The 'iconsize' property is a number and may be specified as:
- An int or float
@@ -64,7 +64,7 @@ def placement(self):
`placement` is "line", the label is placed along the line of
the geometry If `placement` is "line-center", the label is
placed on the center of the geometry
-
+
The 'placement' property is an enumeration that may be specified as:
- One of the following enumeration values:
['point', 'line', 'line-center']
@@ -85,7 +85,7 @@ def placement(self, val):
def text(self):
"""
Sets the symbol text (mapbox.layer.layout.text-field).
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -108,17 +108,17 @@ def textfont(self):
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.layout.mapbox.layer.symbol.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
@@ -155,7 +155,7 @@ def textposition(self):
"""
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',
@@ -216,7 +216,7 @@ def __init__(
):
"""
Construct a new Symbol object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py
index 4bb9a9ae23f..ce8328a542c 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Textfont object
-
+
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".
diff --git a/packages/python/plotly/plotly/graph_objs/layout/newshape/_line.py b/packages/python/plotly/plotly/graph_objs/layout/newshape/_line.py
index 51a91d394f9..75cc9eddc49 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/newshape/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/newshape/_line.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the line color. By default uses either dark grey or white
to increase contrast with background color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -79,7 +79,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is a string and must be specified as:
- One of the following strings:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -102,7 +102,7 @@ def dash(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -136,7 +136,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/_angularaxis.py b/packages/python/plotly/plotly/graph_objs/layout/polar/_angularaxis.py
index a9646800f91..027d1ebedcd 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/_angularaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/_angularaxis.py
@@ -64,7 +64,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -85,7 +85,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -119,7 +119,7 @@ def categoryorder(self):
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean or median of all the
values.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -148,7 +148,7 @@ def color(self):
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)')
@@ -207,7 +207,7 @@ def color(self, val):
def direction(self):
"""
Sets the direction corresponding to positive angles.
-
+
The 'direction' property is an enumeration that may be specified as:
- One of the following enumeration values:
['counterclockwise', 'clockwise']
@@ -247,7 +247,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -270,7 +270,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -291,7 +291,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -350,7 +350,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -377,7 +377,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -403,7 +403,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['above traces', 'below traces']
@@ -424,7 +424,7 @@ def layer(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -483,7 +483,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -527,7 +527,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -549,7 +549,7 @@ def period(self):
"""
Set the angular period. Has an effect only when
`angularaxis.type` is "category".
-
+
The 'period' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -574,7 +574,7 @@ def rotation(self):
due East (like what mathematicians prefer). In turn, polar with
`direction` set to "clockwise" get a rotation of 90 which
corresponds to due North (like on a compass),
-
+
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
@@ -596,7 +596,7 @@ def rotation(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -619,7 +619,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -641,7 +641,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -661,7 +661,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -681,7 +681,7 @@ def showline(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -704,7 +704,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -725,7 +725,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -747,7 +747,7 @@ def thetaunit(self):
"""
Sets the format unit of the formatted "theta" values. Has an
effect only when `angularaxis.type` is "linear".
-
+
The 'thetaunit' property is an enumeration that may be specified as:
- One of the following enumeration values:
['radians', 'degrees']
@@ -776,7 +776,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -797,7 +797,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -819,7 +819,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -878,17 +878,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.angularaxis.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
@@ -931,7 +931,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -956,9 +956,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.polar.angularaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1011,13 +1011,13 @@ def tickformatstopdefaults(self):
When used in a template (as layout.template.layout.polar.angula
raxis.tickformatstopdefaults), sets the default property values
to use for elements of layout.polar.angularaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1036,7 +1036,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1062,7 +1062,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -1083,7 +1083,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1106,7 +1106,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -1127,7 +1127,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1150,7 +1150,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1170,7 +1170,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1191,7 +1191,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1211,7 +1211,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1231,7 +1231,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1254,7 +1254,7 @@ def type(self):
determine the unit in which axis value are shown. If *category,
use `period` to set the number of integer coordinates around
polar axis.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'category']
@@ -1276,7 +1276,7 @@ def uirevision(self):
"""
Controls persistence of user-driven changes in axis `rotation`.
Defaults to `polar.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -1297,7 +1297,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -1590,7 +1590,7 @@ def __init__(
):
"""
Construct a new AngularAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/_domain.py b/packages/python/plotly/plotly/graph_objs/layout/polar/_domain.py
index c8e0beea4b4..27e31caca24 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this polar subplot .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this polar subplot .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this polar subplot (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this polar subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this polar subplot (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this polar subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/_radialaxis.py b/packages/python/plotly/plotly/graph_objs/layout/polar/_radialaxis.py
index 57890ad698c..5057bf1c365 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/_radialaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/_radialaxis.py
@@ -70,7 +70,7 @@ def angle(self):
line corresponds to a line pointing right (like what
mathematicians prefer). Defaults to the first `polar.sector`
angle.
-
+
The 'angle' 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
@@ -94,7 +94,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -118,7 +118,7 @@ def calendar(self):
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`
-
+
The 'calendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -144,7 +144,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -165,7 +165,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -199,7 +199,7 @@ def categoryorder(self):
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean or median of all the
values.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -228,7 +228,7 @@ def color(self):
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)')
@@ -306,7 +306,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -329,7 +329,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -350,7 +350,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -409,7 +409,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -436,7 +436,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -462,7 +462,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['above traces', 'below traces']
@@ -483,7 +483,7 @@ def layer(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -542,7 +542,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -586,7 +586,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -606,24 +606,24 @@ def nticks(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -641,7 +641,7 @@ def rangemode(self):
the input data. If "normal", the range is computed in relation
to the extrema of the input data (same behavior as for
cartesian axes).
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['tozero', 'nonnegative', 'normal']
@@ -662,7 +662,7 @@ def rangemode(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -685,7 +685,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -707,7 +707,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -727,7 +727,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -747,7 +747,7 @@ def showline(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -770,7 +770,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -791,7 +791,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -813,7 +813,7 @@ def side(self):
"""
Determines on which side of radial axis line the tick and tick
labels appear.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['clockwise', 'counterclockwise']
@@ -842,7 +842,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -863,7 +863,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -885,7 +885,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -944,17 +944,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.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
@@ -997,7 +997,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1022,9 +1022,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.polar.radialaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1077,13 +1077,13 @@ def tickformatstopdefaults(self):
When used in a template (as layout.template.layout.polar.radial
axis.tickformatstopdefaults), sets the default property values
to use for elements of layout.polar.radialaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1102,7 +1102,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1128,7 +1128,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -1149,7 +1149,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1172,7 +1172,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -1193,7 +1193,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1216,7 +1216,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1236,7 +1236,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1257,7 +1257,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1277,7 +1277,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1297,7 +1297,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1321,9 +1321,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -1354,17 +1354,17 @@ def titlefont(self):
instead. Sets this axis' 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.polar.radialaxis.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
@@ -1386,7 +1386,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1402,7 +1402,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'log', 'date', 'category']
@@ -1425,7 +1425,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis `range`,
`autorange`, `angle`, and `title` if in `editable: true`
configuration. Defaults to `polar.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -1446,7 +1446,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -1774,7 +1774,7 @@ def __init__(
):
"""
Construct a new RadialAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py
index 671860b4c0c..eca5033d2bd 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py
index d45a622c1e9..758b4fb0927 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py
index 2990c2bfc74..f8e521c1721 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py
index 866087e112c..09d717425e7 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_title.py
index 622d77f6acf..8490c75ec73 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.polar.radialaxis.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
@@ -65,7 +65,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -99,7 +99,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/_font.py
index f5a99f590e4..df63e36edb9 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/polar/radialaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/_annotation.py b/packages/python/plotly/plotly/graph_objs/layout/scene/_annotation.py
index 4fae4503845..7c64cc5765c 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/_annotation.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/_annotation.py
@@ -57,7 +57,7 @@ def align(self):
an effect only if `text` spans two or more lines (i.e. `text`
contains one or more
HTML tags) or if an explicit width is
set to override the text width.
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -78,7 +78,7 @@ def align(self, val):
def arrowcolor(self):
"""
Sets the color of the annotation arrow.
-
+
The 'arrowcolor' 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)')
@@ -137,7 +137,7 @@ def arrowcolor(self, val):
def arrowhead(self):
"""
Sets the end annotation arrow head style.
-
+
The 'arrowhead' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
in the interval [0, 8]
@@ -158,7 +158,7 @@ def arrowhead(self, val):
def arrowside(self):
"""
Sets the annotation arrow head position.
-
+
The 'arrowside' property is a flaglist and may be specified
as a string containing:
- Any combination of ['end', 'start'] joined with '+' characters
@@ -183,7 +183,7 @@ def arrowsize(self):
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.
-
+
The 'arrowsize' property is a number and may be specified as:
- An int or float in the interval [0.3, inf]
@@ -203,7 +203,7 @@ def arrowsize(self, val):
def arrowwidth(self):
"""
Sets the width (in px) of annotation arrow line.
-
+
The 'arrowwidth' property is a number and may be specified as:
- An int or float in the interval [0.1, inf]
@@ -224,7 +224,7 @@ def ax(self):
"""
Sets the x component of the arrow tail about the arrow head (in
pixels).
-
+
The 'ax' property is a number and may be specified as:
- An int or float
@@ -245,7 +245,7 @@ def ay(self):
"""
Sets the y component of the arrow tail about the arrow head (in
pixels).
-
+
The 'ay' property is a number and may be specified as:
- An int or float
@@ -265,7 +265,7 @@ def ay(self, val):
def bgcolor(self):
"""
Sets the background color of the annotation.
-
+
The '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)')
@@ -324,7 +324,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the color of the border enclosing the annotation `text`.
-
+
The 'bordercolor' 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)')
@@ -384,7 +384,7 @@ def borderpad(self):
"""
Sets the padding (in px) between the `text` and the enclosing
border.
-
+
The 'borderpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -405,7 +405,7 @@ def borderwidth(self):
"""
Sets the width (in px) of the border enclosing the annotation
`text`.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -430,7 +430,7 @@ def captureevents(self):
default `captureevents` is False unless `hovertext` is
provided. If you use the event `plotly_clickannotation` without
`hovertext` you must explicitly enable `captureevents`.
-
+
The 'captureevents' property must be specified as a bool
(either True, or False)
@@ -450,17 +450,17 @@ def captureevents(self, val):
def font(self):
"""
Sets the annotation text font.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.annotation.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
@@ -497,7 +497,7 @@ def height(self):
"""
Sets an explicit height for the text box. null (default) lets
the text set the box height. Taller text will be clipped.
-
+
The 'height' property is a number and may be specified as:
- An int or float in the interval [1, inf]
@@ -521,9 +521,9 @@ def hoverlabel(self):
- An instance of :class:`plotly.graph_objs.layout.scene.annotation.Hoverlabel`
- A dict of string/value properties that will be passed
to the Hoverlabel constructor
-
+
Supported dict properties:
-
+
bgcolor
Sets the background color of the hover label.
By default uses the annotation's `bgcolor` made
@@ -554,7 +554,7 @@ def hovertext(self):
"""
Sets text to appear when hovering over this annotation. If
omitted or blank, no hover label will appear.
-
+
The 'hovertext' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -581,7 +581,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -602,7 +602,7 @@ def name(self, val):
def opacity(self):
"""
Sets the opacity of the annotation (text + arrow).
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -624,7 +624,7 @@ def showarrow(self):
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.
-
+
The 'showarrow' property must be specified as a bool
(either True, or False)
@@ -648,7 +648,7 @@ def standoff(self):
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.
-
+
The 'standoff' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -668,7 +668,7 @@ def standoff(self, val):
def startarrowhead(self):
"""
Sets the start annotation arrow head style.
-
+
The 'startarrowhead' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
in the interval [0, 8]
@@ -691,7 +691,7 @@ def startarrowsize(self):
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.
-
+
The 'startarrowsize' property is a number and may be specified as:
- An int or float in the interval [0.3, inf]
@@ -715,7 +715,7 @@ def startstandoff(self):
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.
-
+
The 'startstandoff' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -742,7 +742,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -766,7 +766,7 @@ def text(self):
subset of HTML tags to do things like newline (
), bold
(), italics (), hyperlinks ().
Tags , , are also supported.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -788,7 +788,7 @@ def textangle(self):
"""
Sets the angle at which the `text` is drawn with respect to the
horizontal.
-
+
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
@@ -812,7 +812,7 @@ def valign(self):
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.
-
+
The 'valign' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -833,7 +833,7 @@ def valign(self, val):
def visible(self):
"""
Determines whether or not this annotation is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -855,7 +855,7 @@ def width(self):
Sets an explicit width for the text box. null (default) lets
the text set the box width. Wider text will be clipped. There
is no automatic wrapping; use
to start a new line.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, inf]
@@ -875,7 +875,7 @@ def width(self, val):
def x(self):
"""
Sets the annotation's x position.
-
+
The 'x' property accepts values of any type
Returns
@@ -902,7 +902,7 @@ def xanchor(self):
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.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'left', 'center', 'right']
@@ -924,7 +924,7 @@ def xshift(self):
"""
Shifts the position of the whole annotation and arrow to the
right (positive) or left (negative) by this many pixels.
-
+
The 'xshift' property is a number and may be specified as:
- An int or float
@@ -944,7 +944,7 @@ def xshift(self, val):
def y(self):
"""
Sets the annotation's y position.
-
+
The 'y' property accepts values of any type
Returns
@@ -971,7 +971,7 @@ def yanchor(self):
referenced annotations or if there is an arrow, whereas for
paper-referenced with no arrow, the anchor picked corresponds
to the closest side.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'top', 'middle', 'bottom']
@@ -993,7 +993,7 @@ def yshift(self):
"""
Shifts the position of the whole annotation and arrow up
(positive) or down (negative) by this many pixels.
-
+
The 'yshift' property is a number and may be specified as:
- An int or float
@@ -1013,7 +1013,7 @@ def yshift(self, val):
def z(self):
"""
Sets the annotation's z position.
-
+
The 'z' property accepts values of any type
Returns
@@ -1233,7 +1233,7 @@ def __init__(
):
"""
Construct a new Annotation object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/_aspectratio.py b/packages/python/plotly/plotly/graph_objs/layout/scene/_aspectratio.py
index 3c507d523f4..4de114a168a 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/_aspectratio.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/_aspectratio.py
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Aspectratio object
-
+
Sets this scene's axis aspectratio.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/_camera.py b/packages/python/plotly/plotly/graph_objs/layout/scene/_camera.py
index 320be0f0c2e..6494b19c5b3 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/_camera.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/_camera.py
@@ -18,19 +18,19 @@ def center(self):
Sets the (x,y,z) components of the 'center' camera vector This
vector determines the translation (x,y,z) space about the
center of this scene. By default, there is no such translation.
-
+
The 'center' property is an instance of Center
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.camera.Center`
- A dict of string/value properties that will be passed
to the Center constructor
-
+
Supported dict properties:
-
+
x
-
+
y
-
+
z
Returns
@@ -51,19 +51,19 @@ def eye(self):
Sets the (x,y,z) components of the 'eye' camera vector. This
vector determines the view point about the origin of this
scene.
-
+
The 'eye' property is an instance of Eye
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.camera.Eye`
- A dict of string/value properties that will be passed
to the Eye constructor
-
+
Supported dict properties:
-
+
x
-
+
y
-
+
z
Returns
@@ -86,9 +86,9 @@ def projection(self):
- An instance of :class:`plotly.graph_objs.layout.scene.camera.Projection`
- A dict of string/value properties that will be passed
to the Projection constructor
-
+
Supported dict properties:
-
+
type
Sets the projection type. The projection type
could be either "perspective" or
@@ -113,19 +113,19 @@ def up(self):
vector determines the up direction of this scene with respect
to the page. The default is *{x: 0, y: 0, z: 1}* which means
that the z axis points up.
-
+
The 'up' property is an instance of Up
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.camera.Up`
- A dict of string/value properties that will be passed
to the Up constructor
-
+
Supported dict properties:
-
+
x
-
+
y
-
+
z
Returns
@@ -167,7 +167,7 @@ def __init__(
):
"""
Construct a new Camera object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/_domain.py b/packages/python/plotly/plotly/graph_objs/layout/scene/_domain.py
index 3a645ce9519..d942fa5787d 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this scene subplot .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this scene subplot .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this scene subplot (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this scene subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this scene subplot (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this scene subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/_xaxis.py b/packages/python/plotly/plotly/graph_objs/layout/scene/_xaxis.py
index 10ce2d1a19a..fb2adb4060b 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/_xaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/_xaxis.py
@@ -75,7 +75,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -96,7 +96,7 @@ def autorange(self, val):
def backgroundcolor(self):
"""
Sets the background color of this axis' wall.
-
+
The 'backgroundcolor' 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)')
@@ -158,7 +158,7 @@ def calendar(self):
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`
-
+
The 'calendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -184,7 +184,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -205,7 +205,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -239,7 +239,7 @@ def categoryorder(self):
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean or median of all the
values.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -268,7 +268,7 @@ def color(self):
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)')
@@ -346,7 +346,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -369,7 +369,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -390,7 +390,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -449,7 +449,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -476,7 +476,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -497,7 +497,7 @@ def hoverformat(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -556,7 +556,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -602,7 +602,7 @@ def mirror(self):
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.
-
+
The 'mirror' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, 'ticks', False, 'all', 'allticks']
@@ -626,7 +626,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -646,24 +646,24 @@ def nticks(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -681,7 +681,7 @@ def rangemode(self):
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear axes.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['normal', 'tozero', 'nonnegative']
@@ -702,7 +702,7 @@ def rangemode(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -722,7 +722,7 @@ def separatethousands(self, val):
def showaxeslabels(self):
"""
Sets whether or not this axis is labeled
-
+
The 'showaxeslabels' property must be specified as a bool
(either True, or False)
@@ -742,7 +742,7 @@ def showaxeslabels(self, val):
def showbackground(self):
"""
Sets whether or not this axis' wall has a background color.
-
+
The 'showbackground' property must be specified as a bool
(either True, or False)
@@ -765,7 +765,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -787,7 +787,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -807,7 +807,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -828,7 +828,7 @@ def showspikes(self):
"""
Sets whether or not spikes starting from data points to this
axis' wall are shown on hover.
-
+
The 'showspikes' property must be specified as a bool
(either True, or False)
@@ -848,7 +848,7 @@ def showspikes(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -871,7 +871,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -892,7 +892,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -913,7 +913,7 @@ def showticksuffix(self, val):
def spikecolor(self):
"""
Sets the color of the spikes.
-
+
The 'spikecolor' 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)')
@@ -973,7 +973,7 @@ def spikesides(self):
"""
Sets whether or not spikes extending from the projection data
points to this axis' wall boundaries are shown on hover.
-
+
The 'spikesides' property must be specified as a bool
(either True, or False)
@@ -993,7 +993,7 @@ def spikesides(self, val):
def spikethickness(self):
"""
Sets the thickness (in px) of the spikes.
-
+
The 'spikethickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1021,7 +1021,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -1042,7 +1042,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -1064,7 +1064,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -1123,17 +1123,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.xaxis.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
@@ -1176,7 +1176,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1201,9 +1201,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.scene.xaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1257,13 +1257,13 @@ def tickformatstopdefaults(self):
layout.template.layout.scene.xaxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.scene.xaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1282,7 +1282,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1308,7 +1308,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -1329,7 +1329,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1352,7 +1352,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -1373,7 +1373,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1396,7 +1396,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1416,7 +1416,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1437,7 +1437,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1457,7 +1457,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1477,7 +1477,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1501,9 +1501,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -1533,17 +1533,17 @@ def titlefont(self):
Deprecated: Please use layout.scene.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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.xaxis.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
@@ -1565,7 +1565,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1581,7 +1581,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'log', 'date', 'category']
@@ -1604,7 +1604,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -1626,7 +1626,7 @@ def zeroline(self):
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.
-
+
The 'zeroline' property must be specified as a bool
(either True, or False)
@@ -1646,7 +1646,7 @@ def zeroline(self, val):
def zerolinecolor(self):
"""
Sets the line color of the zero line.
-
+
The 'zerolinecolor' 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)')
@@ -1705,7 +1705,7 @@ def zerolinecolor(self, val):
def zerolinewidth(self):
"""
Sets the width (in px) of the zero line.
-
+
The 'zerolinewidth' property is a number and may be specified as:
- An int or float
@@ -2052,7 +2052,7 @@ def __init__(
):
"""
Construct a new XAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/_yaxis.py b/packages/python/plotly/plotly/graph_objs/layout/scene/_yaxis.py
index 410f8fe7f28..af23ef3d439 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/_yaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/_yaxis.py
@@ -75,7 +75,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -96,7 +96,7 @@ def autorange(self, val):
def backgroundcolor(self):
"""
Sets the background color of this axis' wall.
-
+
The 'backgroundcolor' 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)')
@@ -158,7 +158,7 @@ def calendar(self):
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`
-
+
The 'calendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -184,7 +184,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -205,7 +205,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -239,7 +239,7 @@ def categoryorder(self):
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean or median of all the
values.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -268,7 +268,7 @@ def color(self):
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)')
@@ -346,7 +346,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -369,7 +369,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -390,7 +390,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -449,7 +449,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -476,7 +476,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -497,7 +497,7 @@ def hoverformat(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -556,7 +556,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -602,7 +602,7 @@ def mirror(self):
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.
-
+
The 'mirror' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, 'ticks', False, 'all', 'allticks']
@@ -626,7 +626,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -646,24 +646,24 @@ def nticks(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -681,7 +681,7 @@ def rangemode(self):
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear axes.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['normal', 'tozero', 'nonnegative']
@@ -702,7 +702,7 @@ def rangemode(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -722,7 +722,7 @@ def separatethousands(self, val):
def showaxeslabels(self):
"""
Sets whether or not this axis is labeled
-
+
The 'showaxeslabels' property must be specified as a bool
(either True, or False)
@@ -742,7 +742,7 @@ def showaxeslabels(self, val):
def showbackground(self):
"""
Sets whether or not this axis' wall has a background color.
-
+
The 'showbackground' property must be specified as a bool
(either True, or False)
@@ -765,7 +765,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -787,7 +787,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -807,7 +807,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -828,7 +828,7 @@ def showspikes(self):
"""
Sets whether or not spikes starting from data points to this
axis' wall are shown on hover.
-
+
The 'showspikes' property must be specified as a bool
(either True, or False)
@@ -848,7 +848,7 @@ def showspikes(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -871,7 +871,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -892,7 +892,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -913,7 +913,7 @@ def showticksuffix(self, val):
def spikecolor(self):
"""
Sets the color of the spikes.
-
+
The 'spikecolor' 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)')
@@ -973,7 +973,7 @@ def spikesides(self):
"""
Sets whether or not spikes extending from the projection data
points to this axis' wall boundaries are shown on hover.
-
+
The 'spikesides' property must be specified as a bool
(either True, or False)
@@ -993,7 +993,7 @@ def spikesides(self, val):
def spikethickness(self):
"""
Sets the thickness (in px) of the spikes.
-
+
The 'spikethickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1021,7 +1021,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -1042,7 +1042,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -1064,7 +1064,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -1123,17 +1123,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.yaxis.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
@@ -1176,7 +1176,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1201,9 +1201,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.scene.yaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1257,13 +1257,13 @@ def tickformatstopdefaults(self):
layout.template.layout.scene.yaxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.scene.yaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1282,7 +1282,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1308,7 +1308,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -1329,7 +1329,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1352,7 +1352,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -1373,7 +1373,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1396,7 +1396,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1416,7 +1416,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1437,7 +1437,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1457,7 +1457,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1477,7 +1477,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1501,9 +1501,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -1533,17 +1533,17 @@ def titlefont(self):
Deprecated: Please use layout.scene.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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.yaxis.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
@@ -1565,7 +1565,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1581,7 +1581,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'log', 'date', 'category']
@@ -1604,7 +1604,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -1626,7 +1626,7 @@ def zeroline(self):
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.
-
+
The 'zeroline' property must be specified as a bool
(either True, or False)
@@ -1646,7 +1646,7 @@ def zeroline(self, val):
def zerolinecolor(self):
"""
Sets the line color of the zero line.
-
+
The 'zerolinecolor' 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)')
@@ -1705,7 +1705,7 @@ def zerolinecolor(self, val):
def zerolinewidth(self):
"""
Sets the width (in px) of the zero line.
-
+
The 'zerolinewidth' property is a number and may be specified as:
- An int or float
@@ -2052,7 +2052,7 @@ def __init__(
):
"""
Construct a new YAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/_zaxis.py b/packages/python/plotly/plotly/graph_objs/layout/scene/_zaxis.py
index 213830d3af4..0612a219789 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/_zaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/_zaxis.py
@@ -75,7 +75,7 @@ def autorange(self):
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.
-
+
The 'autorange' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -96,7 +96,7 @@ def autorange(self, val):
def backgroundcolor(self):
"""
Sets the background color of this axis' wall.
-
+
The 'backgroundcolor' 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)')
@@ -158,7 +158,7 @@ def calendar(self):
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`
-
+
The 'calendar' property is an enumeration that may be specified as:
- One of the following enumeration values:
['gregorian', 'chinese', 'coptic', 'discworld',
@@ -184,7 +184,7 @@ def categoryarray(self):
Sets the order in which categories on this axis appear. Only
has an effect if `categoryorder` is set to "array". Used with
`categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -205,7 +205,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -239,7 +239,7 @@ def categoryorder(self):
numerical order of the values. Similarly, the order can be
determined by the min, max, sum, mean or median of all the
values.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -268,7 +268,7 @@ def color(self):
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)')
@@ -346,7 +346,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -369,7 +369,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -390,7 +390,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -449,7 +449,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -476,7 +476,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -497,7 +497,7 @@ def hoverformat(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -556,7 +556,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -602,7 +602,7 @@ def mirror(self):
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.
-
+
The 'mirror' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, 'ticks', False, 'all', 'allticks']
@@ -626,7 +626,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -646,24 +646,24 @@ def nticks(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -681,7 +681,7 @@ def rangemode(self):
regardless of the input data If "nonnegative", the range is
non-negative, regardless of the input data. Applies only to
linear axes.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['normal', 'tozero', 'nonnegative']
@@ -702,7 +702,7 @@ def rangemode(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -722,7 +722,7 @@ def separatethousands(self, val):
def showaxeslabels(self):
"""
Sets whether or not this axis is labeled
-
+
The 'showaxeslabels' property must be specified as a bool
(either True, or False)
@@ -742,7 +742,7 @@ def showaxeslabels(self, val):
def showbackground(self):
"""
Sets whether or not this axis' wall has a background color.
-
+
The 'showbackground' property must be specified as a bool
(either True, or False)
@@ -765,7 +765,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -787,7 +787,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -807,7 +807,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -828,7 +828,7 @@ def showspikes(self):
"""
Sets whether or not spikes starting from data points to this
axis' wall are shown on hover.
-
+
The 'showspikes' property must be specified as a bool
(either True, or False)
@@ -848,7 +848,7 @@ def showspikes(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -871,7 +871,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -892,7 +892,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -913,7 +913,7 @@ def showticksuffix(self, val):
def spikecolor(self):
"""
Sets the color of the spikes.
-
+
The 'spikecolor' 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)')
@@ -973,7 +973,7 @@ def spikesides(self):
"""
Sets whether or not spikes extending from the projection data
points to this axis' wall boundaries are shown on hover.
-
+
The 'spikesides' property must be specified as a bool
(either True, or False)
@@ -993,7 +993,7 @@ def spikesides(self, val):
def spikethickness(self):
"""
Sets the thickness (in px) of the spikes.
-
+
The 'spikethickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1021,7 +1021,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -1042,7 +1042,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -1064,7 +1064,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -1123,17 +1123,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.zaxis.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
@@ -1176,7 +1176,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1201,9 +1201,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.scene.zaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -1257,13 +1257,13 @@ def tickformatstopdefaults(self):
layout.template.layout.scene.zaxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.scene.zaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -1282,7 +1282,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1308,7 +1308,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -1329,7 +1329,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1352,7 +1352,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -1373,7 +1373,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -1396,7 +1396,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1416,7 +1416,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1437,7 +1437,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1457,7 +1457,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1477,7 +1477,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1501,9 +1501,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -1533,17 +1533,17 @@ def titlefont(self):
Deprecated: Please use layout.scene.zaxis.title.font instead.
Sets this axis' 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.scene.zaxis.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
@@ -1565,7 +1565,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1581,7 +1581,7 @@ def type(self):
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.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['-', 'linear', 'log', 'date', 'category']
@@ -1604,7 +1604,7 @@ def visible(self):
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
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -1626,7 +1626,7 @@ def zeroline(self):
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.
-
+
The 'zeroline' property must be specified as a bool
(either True, or False)
@@ -1646,7 +1646,7 @@ def zeroline(self, val):
def zerolinecolor(self):
"""
Sets the line color of the zero line.
-
+
The 'zerolinecolor' 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)')
@@ -1705,7 +1705,7 @@ def zerolinecolor(self, val):
def zerolinewidth(self):
"""
Sets the width (in px) of the zero line.
-
+
The 'zerolinewidth' property is a number and may be specified as:
- An int or float
@@ -2052,7 +2052,7 @@ def __init__(
):
"""
Construct a new ZAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_font.py b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_font.py
index 74cb36cc3ef..2939c6053fc 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the annotation text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py
index c4ea67ce5bb..8abd89ba3fa 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py
@@ -18,7 +18,7 @@ def bgcolor(self):
Sets the background color of the hover label. By default uses
the annotation's `bgcolor` made opaque, or white if it was
transparent.
-
+
The '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)')
@@ -79,7 +79,7 @@ def bordercolor(self):
Sets the border color of the hover label. By default uses
either dark grey or white, for maximum contrast with
`hoverlabel.bgcolor`.
-
+
The 'bordercolor' 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)')
@@ -139,17 +139,17 @@ def font(self):
"""
Sets the hover label text font. By default uses the global
hover font and size, with color from `hoverlabel.bordercolor`.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.scene.annotation.hoverlabel.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
@@ -201,7 +201,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py
index c5d9a9893fd..4cfd442605b 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the hover label text font. By default uses the global
hover font and size, with color from `hoverlabel.bordercolor`.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_center.py b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_center.py
index 37e9bbc1e68..a8ae3b85330 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_center.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_center.py
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Center object
-
+
Sets the (x,y,z) components of the 'center' camera vector This
vector determines the translation (x,y,z) space about the
center of this scene. By default, there is no such translation.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_eye.py b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_eye.py
index 9eaa37e68a2..49ec403f482 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_eye.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_eye.py
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Eye object
-
+
Sets the (x,y,z) components of the 'eye' camera vector. This
vector determines the view point about the origin of this
scene.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_projection.py b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_projection.py
index f216c1838dc..8ec2603617a 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_projection.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_projection.py
@@ -17,7 +17,7 @@ def type(self):
"""
Sets the projection type. The projection type could be either
"perspective" or "orthographic". The default is "perspective".
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['perspective', 'orthographic']
@@ -46,7 +46,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, type=None, **kwargs):
"""
Construct a new Projection object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_up.py b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_up.py
index 574ecf4d952..92f94b1b0f5 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_up.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/camera/_up.py
@@ -80,7 +80,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Up object
-
+
Sets the (x,y,z) components of the 'up' camera vector. This
vector determines the up direction of this scene with respect
to the page. The default is *{x: 0, y: 0, z: 1}* which means
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickfont.py
index 885235256e5..f2047f82fb7 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py
index f7d9da7dcde..b032988e271 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_title.py
index 23b72f2edfa..f2c4f46304f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.scene.xaxis.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
@@ -65,7 +65,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -99,7 +99,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/_font.py
index 2793cbfea5c..3b6e3fdc952 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/xaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickfont.py
index 3ecce074b23..d5204d90add 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py
index d5456c5e05d..a6a017c0295 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_title.py
index f22b91ed0f2..a9cd48b71a7 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.scene.yaxis.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
@@ -65,7 +65,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -99,7 +99,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/_font.py
index fc306d95b66..2e8f8489f19 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/yaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickfont.py
index d7af88a4d4d..e59ca5c16b5 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py
index 4cea84a025d..516ce28ef2e 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_title.py
index 61f4a769e10..8054c69e346 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.scene.zaxis.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
@@ -65,7 +65,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -99,7 +99,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/_font.py
index a3a795fd788..4a5b6398d3a 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/scene/zaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/shape/_line.py b/packages/python/plotly/plotly/graph_objs/layout/shape/_line.py
index 4087dd28d1c..8dcf8c8202e 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/shape/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/shape/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseLayoutHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is a string and must be specified as:
- One of the following strings:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -101,7 +101,7 @@ def dash(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -134,7 +134,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/_currentvalue.py b/packages/python/plotly/plotly/graph_objs/layout/slider/_currentvalue.py
index c96c7cc7457..a04ca8d6950 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/slider/_currentvalue.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/slider/_currentvalue.py
@@ -16,17 +16,17 @@ class Currentvalue(_BaseLayoutHierarchyType):
def font(self):
"""
Sets the font of the current value label text.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.slider.currentvalue.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
@@ -63,7 +63,7 @@ def offset(self):
"""
The amount of space, in pixels, between the current value label
and the slider.
-
+
The 'offset' property is a number and may be specified as:
- An int or float
@@ -84,7 +84,7 @@ def prefix(self):
"""
When currentvalue.visible is true, this sets the prefix of the
label.
-
+
The 'prefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -106,7 +106,7 @@ def suffix(self):
"""
When currentvalue.visible is true, this sets the suffix of the
label.
-
+
The 'suffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def suffix(self, val):
def visible(self):
"""
Shows the currently-selected value above the slider.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -148,7 +148,7 @@ def xanchor(self):
"""
The alignment of the value readout relative to the length of
the slider.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -199,7 +199,7 @@ def __init__(
):
"""
Construct a new Currentvalue object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/_font.py b/packages/python/plotly/plotly/graph_objs/layout/slider/_font.py
index c4620d800cb..63bdd36bf39 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/slider/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/slider/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the font of the slider step labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/_pad.py b/packages/python/plotly/plotly/graph_objs/layout/slider/_pad.py
index afd357af5f4..d80c450b23f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/slider/_pad.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/slider/_pad.py
@@ -17,7 +17,7 @@ def b(self):
"""
The amount of padding (in px) along the bottom of the
component.
-
+
The 'b' property is a number and may be specified as:
- An int or float
@@ -38,7 +38,7 @@ def l(self):
"""
The amount of padding (in px) on the left side of the
component.
-
+
The 'l' property is a number and may be specified as:
- An int or float
@@ -59,7 +59,7 @@ def r(self):
"""
The amount of padding (in px) on the right side of the
component.
-
+
The 'r' property is a number and may be specified as:
- An int or float
@@ -79,7 +79,7 @@ def r(self, val):
def t(self):
"""
The amount of padding (in px) along the top of the component.
-
+
The 't' property is a number and may be specified as:
- An int or float
@@ -115,7 +115,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs):
"""
Construct a new Pad object
-
+
Set the padding of the slider component along each side.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/_step.py b/packages/python/plotly/plotly/graph_objs/layout/slider/_step.py
index 6f13cc385fb..72ff1a27f58 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/slider/_step.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/slider/_step.py
@@ -24,19 +24,19 @@ class Step(_BaseLayoutHierarchyType):
@property
def args(self):
"""
- Sets the arguments values to be passed to the Plotly method set
- in `method` on slide.
-
- The 'args' property is an info array that may be specified as:
-
- * a list or tuple of up to 3 elements where:
- (0) The 'args[0]' property accepts values of any type
- (1) The 'args[1]' property accepts values of any type
- (2) The 'args[2]' property accepts values of any type
+ Sets the arguments values to be passed to the Plotly method set
+ in `method` on slide.
- Returns
- -------
- list
+ The 'args' property is an info array that may be specified as:
+
+ * a list or tuple of up to 3 elements where:
+ (0) The 'args[0]' property accepts values of any type
+ (1) The 'args[1]' property accepts values of any type
+ (2) The 'args[2]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["args"]
@@ -56,7 +56,7 @@ def execute(self):
manually without losing the benefit of the slider automatically
binding to the state of the plot through the specification of
`method` and `args`.
-
+
The 'execute' property must be specified as a bool
(either True, or False)
@@ -76,7 +76,7 @@ def execute(self, val):
def label(self):
"""
Sets the text label to appear on the slider
-
+
The 'label' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -102,7 +102,7 @@ def method(self):
bind automatically to state updates. This may be used to create
a component interface and attach to slider events manually via
JavaScript.
-
+
The 'method' property is an enumeration that may be specified as:
- One of the following enumeration values:
['restyle', 'relayout', 'animate', 'update', 'skip']
@@ -129,7 +129,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -157,7 +157,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -179,7 +179,7 @@ def value(self):
"""
Sets the value of the slider step, used to refer to the step
programatically. Defaults to the slider label if not provided.
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -200,7 +200,7 @@ def value(self, val):
def visible(self):
"""
Determines whether or not this step is included in the slider.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -282,7 +282,7 @@ def __init__(
):
"""
Construct a new Step object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/_transition.py b/packages/python/plotly/plotly/graph_objs/layout/slider/_transition.py
index 73d3931fef2..276267b387c 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/slider/_transition.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/slider/_transition.py
@@ -16,7 +16,7 @@ class Transition(_BaseLayoutHierarchyType):
def duration(self):
"""
Sets the duration of the slider transition
-
+
The 'duration' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -36,7 +36,7 @@ def duration(self, val):
def easing(self):
"""
Sets the easing function of the slider transition
-
+
The 'easing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'quad', 'cubic', 'sin', 'exp', 'circle',
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, duration=None, easing=None, **kwargs):
"""
Construct a new Transition object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/_font.py b/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/_font.py
index fa8f3e0205d..a63bc531a5d 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/slider/currentvalue/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the font of the current value label text.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/template/_data.py b/packages/python/plotly/plotly/graph_objs/layout/template/_data.py
index fdd76a97d0d..d70ced71fa9 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/template/_data.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/template/_data.py
@@ -68,7 +68,7 @@ def area(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Area
- A list or tuple of dicts of string/value properties that
will be passed to the Area constructor
-
+
Supported dict properties:
Returns
@@ -91,7 +91,7 @@ def barpolar(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Barpolar
- A list or tuple of dicts of string/value properties that
will be passed to the Barpolar constructor
-
+
Supported dict properties:
Returns
@@ -114,7 +114,7 @@ def bar(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Bar
- A list or tuple of dicts of string/value properties that
will be passed to the Bar constructor
-
+
Supported dict properties:
Returns
@@ -137,7 +137,7 @@ def box(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Box
- A list or tuple of dicts of string/value properties that
will be passed to the Box constructor
-
+
Supported dict properties:
Returns
@@ -160,7 +160,7 @@ def candlestick(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Candlestick
- A list or tuple of dicts of string/value properties that
will be passed to the Candlestick constructor
-
+
Supported dict properties:
Returns
@@ -183,7 +183,7 @@ def carpet(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Carpet
- A list or tuple of dicts of string/value properties that
will be passed to the Carpet constructor
-
+
Supported dict properties:
Returns
@@ -206,7 +206,7 @@ def choroplethmapbox(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Choroplethmapbox
- A list or tuple of dicts of string/value properties that
will be passed to the Choroplethmapbox constructor
-
+
Supported dict properties:
Returns
@@ -229,7 +229,7 @@ def choropleth(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Choropleth
- A list or tuple of dicts of string/value properties that
will be passed to the Choropleth constructor
-
+
Supported dict properties:
Returns
@@ -252,7 +252,7 @@ def cone(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Cone
- A list or tuple of dicts of string/value properties that
will be passed to the Cone constructor
-
+
Supported dict properties:
Returns
@@ -275,7 +275,7 @@ def contourcarpet(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Contourcarpet
- A list or tuple of dicts of string/value properties that
will be passed to the Contourcarpet constructor
-
+
Supported dict properties:
Returns
@@ -298,7 +298,7 @@ def contour(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Contour
- A list or tuple of dicts of string/value properties that
will be passed to the Contour constructor
-
+
Supported dict properties:
Returns
@@ -321,7 +321,7 @@ def densitymapbox(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Densitymapbox
- A list or tuple of dicts of string/value properties that
will be passed to the Densitymapbox constructor
-
+
Supported dict properties:
Returns
@@ -344,7 +344,7 @@ def funnelarea(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Funnelarea
- A list or tuple of dicts of string/value properties that
will be passed to the Funnelarea constructor
-
+
Supported dict properties:
Returns
@@ -367,7 +367,7 @@ def funnel(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Funnel
- A list or tuple of dicts of string/value properties that
will be passed to the Funnel constructor
-
+
Supported dict properties:
Returns
@@ -390,7 +390,7 @@ def heatmapgl(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Heatmapgl
- A list or tuple of dicts of string/value properties that
will be passed to the Heatmapgl constructor
-
+
Supported dict properties:
Returns
@@ -413,7 +413,7 @@ def heatmap(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Heatmap
- A list or tuple of dicts of string/value properties that
will be passed to the Heatmap constructor
-
+
Supported dict properties:
Returns
@@ -436,7 +436,7 @@ def histogram2dcontour(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Histogram2dContour
- A list or tuple of dicts of string/value properties that
will be passed to the Histogram2dContour constructor
-
+
Supported dict properties:
Returns
@@ -459,7 +459,7 @@ def histogram2d(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Histogram2d
- A list or tuple of dicts of string/value properties that
will be passed to the Histogram2d constructor
-
+
Supported dict properties:
Returns
@@ -482,7 +482,7 @@ def histogram(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Histogram
- A list or tuple of dicts of string/value properties that
will be passed to the Histogram constructor
-
+
Supported dict properties:
Returns
@@ -505,7 +505,7 @@ def image(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Image
- A list or tuple of dicts of string/value properties that
will be passed to the Image constructor
-
+
Supported dict properties:
Returns
@@ -528,7 +528,7 @@ def indicator(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Indicator
- A list or tuple of dicts of string/value properties that
will be passed to the Indicator constructor
-
+
Supported dict properties:
Returns
@@ -551,7 +551,7 @@ def isosurface(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Isosurface
- A list or tuple of dicts of string/value properties that
will be passed to the Isosurface constructor
-
+
Supported dict properties:
Returns
@@ -574,7 +574,7 @@ def mesh3d(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Mesh3d
- A list or tuple of dicts of string/value properties that
will be passed to the Mesh3d constructor
-
+
Supported dict properties:
Returns
@@ -597,7 +597,7 @@ def ohlc(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Ohlc
- A list or tuple of dicts of string/value properties that
will be passed to the Ohlc constructor
-
+
Supported dict properties:
Returns
@@ -620,7 +620,7 @@ def parcats(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Parcats
- A list or tuple of dicts of string/value properties that
will be passed to the Parcats constructor
-
+
Supported dict properties:
Returns
@@ -643,7 +643,7 @@ def parcoords(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Parcoords
- A list or tuple of dicts of string/value properties that
will be passed to the Parcoords constructor
-
+
Supported dict properties:
Returns
@@ -666,7 +666,7 @@ def pie(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Pie
- A list or tuple of dicts of string/value properties that
will be passed to the Pie constructor
-
+
Supported dict properties:
Returns
@@ -689,7 +689,7 @@ def pointcloud(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Pointcloud
- A list or tuple of dicts of string/value properties that
will be passed to the Pointcloud constructor
-
+
Supported dict properties:
Returns
@@ -712,7 +712,7 @@ def sankey(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Sankey
- A list or tuple of dicts of string/value properties that
will be passed to the Sankey constructor
-
+
Supported dict properties:
Returns
@@ -735,7 +735,7 @@ def scatter3d(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatter3d
- A list or tuple of dicts of string/value properties that
will be passed to the Scatter3d constructor
-
+
Supported dict properties:
Returns
@@ -758,7 +758,7 @@ def scattercarpet(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattercarpet
- A list or tuple of dicts of string/value properties that
will be passed to the Scattercarpet constructor
-
+
Supported dict properties:
Returns
@@ -781,7 +781,7 @@ def scattergeo(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergeo
- A list or tuple of dicts of string/value properties that
will be passed to the Scattergeo constructor
-
+
Supported dict properties:
Returns
@@ -804,7 +804,7 @@ def scattergl(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergl
- A list or tuple of dicts of string/value properties that
will be passed to the Scattergl constructor
-
+
Supported dict properties:
Returns
@@ -827,7 +827,7 @@ def scattermapbox(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattermapbox
- A list or tuple of dicts of string/value properties that
will be passed to the Scattermapbox constructor
-
+
Supported dict properties:
Returns
@@ -850,7 +850,7 @@ def scatterpolargl(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolargl
- A list or tuple of dicts of string/value properties that
will be passed to the Scatterpolargl constructor
-
+
Supported dict properties:
Returns
@@ -873,7 +873,7 @@ def scatterpolar(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolar
- A list or tuple of dicts of string/value properties that
will be passed to the Scatterpolar constructor
-
+
Supported dict properties:
Returns
@@ -896,7 +896,7 @@ def scatter(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatter
- A list or tuple of dicts of string/value properties that
will be passed to the Scatter constructor
-
+
Supported dict properties:
Returns
@@ -919,7 +919,7 @@ def scatterternary(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterternary
- A list or tuple of dicts of string/value properties that
will be passed to the Scatterternary constructor
-
+
Supported dict properties:
Returns
@@ -942,7 +942,7 @@ def splom(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Splom
- A list or tuple of dicts of string/value properties that
will be passed to the Splom constructor
-
+
Supported dict properties:
Returns
@@ -965,7 +965,7 @@ def streamtube(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Streamtube
- A list or tuple of dicts of string/value properties that
will be passed to the Streamtube constructor
-
+
Supported dict properties:
Returns
@@ -988,7 +988,7 @@ def sunburst(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Sunburst
- A list or tuple of dicts of string/value properties that
will be passed to the Sunburst constructor
-
+
Supported dict properties:
Returns
@@ -1011,7 +1011,7 @@ def surface(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Surface
- A list or tuple of dicts of string/value properties that
will be passed to the Surface constructor
-
+
Supported dict properties:
Returns
@@ -1034,7 +1034,7 @@ def table(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Table
- A list or tuple of dicts of string/value properties that
will be passed to the Table constructor
-
+
Supported dict properties:
Returns
@@ -1057,7 +1057,7 @@ def treemap(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Treemap
- A list or tuple of dicts of string/value properties that
will be passed to the Treemap constructor
-
+
Supported dict properties:
Returns
@@ -1080,7 +1080,7 @@ def violin(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Violin
- A list or tuple of dicts of string/value properties that
will be passed to the Violin constructor
-
+
Supported dict properties:
Returns
@@ -1103,7 +1103,7 @@ def volume(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Volume
- A list or tuple of dicts of string/value properties that
will be passed to the Volume constructor
-
+
Supported dict properties:
Returns
@@ -1126,7 +1126,7 @@ def waterfall(self):
- A list or tuple of instances of plotly.graph_objs.layout.template.data.Waterfall
- A list or tuple of dicts of string/value properties that
will be passed to the Waterfall constructor
-
+
Supported dict properties:
Returns
@@ -1343,7 +1343,7 @@ def __init__(
):
"""
Construct a new Data object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/_aaxis.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/_aaxis.py
index 7a4b196a200..5acf5bc98c4 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/_aaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/_aaxis.py
@@ -59,7 +59,7 @@ def color(self):
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)')
@@ -137,7 +137,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -160,7 +160,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -181,7 +181,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -240,7 +240,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -267,7 +267,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -293,7 +293,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['above traces', 'below traces']
@@ -314,7 +314,7 @@ def layer(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -373,7 +373,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -395,7 +395,7 @@ def min(self):
The minimum value visible on this axis. The maximum is
determined by the sum minus the minimum values of the other two
axes. The full view corresponds to all the minima set to zero.
-
+
The 'min' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -439,7 +439,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -460,7 +460,7 @@ def nticks(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -483,7 +483,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -505,7 +505,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -525,7 +525,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -545,7 +545,7 @@ def showline(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -568,7 +568,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -589,7 +589,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -618,7 +618,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -639,7 +639,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -661,7 +661,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -720,17 +720,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.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
@@ -773,7 +773,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -798,9 +798,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.ternary.aaxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -854,13 +854,13 @@ def tickformatstopdefaults(self):
layout.template.layout.ternary.aaxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.ternary.aaxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -879,7 +879,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -905,7 +905,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -926,7 +926,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -949,7 +949,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -970,7 +970,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -993,7 +993,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1013,7 +1013,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1034,7 +1034,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1054,7 +1054,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1074,7 +1074,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1098,9 +1098,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -1130,17 +1130,17 @@ def titlefont(self):
Deprecated: Please use layout.ternary.aaxis.title.font instead.
Sets this axis' 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.ternary.aaxis.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
@@ -1162,7 +1162,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1178,7 +1178,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis `min`, and
`title` if in `editable: true` configuration. Defaults to
`ternary.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -1431,7 +1431,7 @@ def __init__(
):
"""
Construct a new Aaxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/_baxis.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/_baxis.py
index 6fbf8f06fa2..81e8014a444 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/_baxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/_baxis.py
@@ -59,7 +59,7 @@ def color(self):
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)')
@@ -137,7 +137,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -160,7 +160,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -181,7 +181,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -240,7 +240,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -267,7 +267,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -293,7 +293,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['above traces', 'below traces']
@@ -314,7 +314,7 @@ def layer(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -373,7 +373,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -395,7 +395,7 @@ def min(self):
The minimum value visible on this axis. The maximum is
determined by the sum minus the minimum values of the other two
axes. The full view corresponds to all the minima set to zero.
-
+
The 'min' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -439,7 +439,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -460,7 +460,7 @@ def nticks(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -483,7 +483,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -505,7 +505,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -525,7 +525,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -545,7 +545,7 @@ def showline(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -568,7 +568,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -589,7 +589,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -618,7 +618,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -639,7 +639,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -661,7 +661,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -720,17 +720,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.baxis.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
@@ -773,7 +773,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -798,9 +798,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.ternary.baxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -854,13 +854,13 @@ def tickformatstopdefaults(self):
layout.template.layout.ternary.baxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.ternary.baxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -879,7 +879,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -905,7 +905,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -926,7 +926,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -949,7 +949,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -970,7 +970,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -993,7 +993,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1013,7 +1013,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1034,7 +1034,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1054,7 +1054,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1074,7 +1074,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1098,9 +1098,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -1130,17 +1130,17 @@ def titlefont(self):
Deprecated: Please use layout.ternary.baxis.title.font instead.
Sets this axis' 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.ternary.baxis.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
@@ -1162,7 +1162,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1178,7 +1178,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis `min`, and
`title` if in `editable: true` configuration. Defaults to
`ternary.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -1431,7 +1431,7 @@ def __init__(
):
"""
Construct a new Baxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/_caxis.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/_caxis.py
index 11b2df94fd1..bdd11fa324f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/_caxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/_caxis.py
@@ -59,7 +59,7 @@ def color(self):
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)')
@@ -137,7 +137,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -160,7 +160,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -181,7 +181,7 @@ def exponentformat(self, val):
def gridcolor(self):
"""
Sets the color of the grid lines.
-
+
The 'gridcolor' 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)')
@@ -240,7 +240,7 @@ def gridcolor(self, val):
def gridwidth(self):
"""
Sets the width (in px) of the grid lines.
-
+
The 'gridwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -267,7 +267,7 @@ def hoverformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'hoverformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -293,7 +293,7 @@ def layer(self):
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.
-
+
The 'layer' property is an enumeration that may be specified as:
- One of the following enumeration values:
['above traces', 'below traces']
@@ -314,7 +314,7 @@ def layer(self, val):
def linecolor(self):
"""
Sets the axis line color.
-
+
The 'linecolor' 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)')
@@ -373,7 +373,7 @@ def linecolor(self, val):
def linewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'linewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -395,7 +395,7 @@ def min(self):
The minimum value visible on this axis. The maximum is
determined by the sum minus the minimum values of the other two
axes. The full view corresponds to all the minima set to zero.
-
+
The 'min' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -439,7 +439,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -460,7 +460,7 @@ def nticks(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -483,7 +483,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -505,7 +505,7 @@ def showgrid(self):
"""
Determines whether or not grid lines are drawn. If True, the
grid lines are drawn at every tick mark.
-
+
The 'showgrid' property must be specified as a bool
(either True, or False)
@@ -525,7 +525,7 @@ def showgrid(self, val):
def showline(self):
"""
Determines whether or not a line bounding this axis is drawn.
-
+
The 'showline' property must be specified as a bool
(either True, or False)
@@ -545,7 +545,7 @@ def showline(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -568,7 +568,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -589,7 +589,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -618,7 +618,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -639,7 +639,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -661,7 +661,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -720,17 +720,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the tick font.
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.caxis.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
@@ -773,7 +773,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -798,9 +798,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.layout.ternary.caxis.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -854,13 +854,13 @@ def tickformatstopdefaults(self):
layout.template.layout.ternary.caxis.tickformatstopdefaults),
sets the default property values to use for elements of
layout.ternary.caxis.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -879,7 +879,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -905,7 +905,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -926,7 +926,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -949,7 +949,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -970,7 +970,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -993,7 +993,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1013,7 +1013,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1034,7 +1034,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1054,7 +1054,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1074,7 +1074,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1098,9 +1098,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this axis' title font. Note that the
title's font used to be customized by the now
@@ -1130,17 +1130,17 @@ def titlefont(self):
Deprecated: Please use layout.ternary.caxis.title.font instead.
Sets this axis' 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.ternary.caxis.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
@@ -1162,7 +1162,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1178,7 +1178,7 @@ def uirevision(self):
Controls persistence of user-driven changes in axis `min`, and
`title` if in `editable: true` configuration. Defaults to
`ternary.uirevision`.
-
+
The 'uirevision' property accepts values of any type
Returns
@@ -1431,7 +1431,7 @@ def __init__(
):
"""
Construct a new Caxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/_domain.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/_domain.py
index e17b94fc518..ad1421cd7a0 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this ternary subplot .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this ternary subplot .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this ternary subplot (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this ternary subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this ternary subplot (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this ternary subplot (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py
index 0402b4e2922..3e41ecfca72 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py
index 84408728ebe..8e5576583c3 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_title.py
index f0dfe2a2b38..64c6c6ced31 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.ternary.aaxis.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
@@ -65,7 +65,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -99,7 +99,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/_font.py
index 79535e6f9ec..181c59528ed 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/aaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickfont.py
index 977a1d69c5e..71f6e175361 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py
index 953df56778c..0ed04f58dcc 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_title.py
index 41fc4e7ae53..7cc02eba938 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.ternary.baxis.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
@@ -65,7 +65,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -99,7 +99,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/_font.py
index 4621061325b..7ae5ef0ce1f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/baxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickfont.py
index e9aa130d6b4..2f10242b91f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py
index 944ba5c5abf..4fe22622d74 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_title.py
index 8f6559b2133..6326c6ad680 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.ternary.caxis.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
@@ -65,7 +65,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -99,7 +99,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/_font.py
index 2f451f456e5..78eac2ced6f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/ternary/caxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/title/_font.py
index 0c1ab62fedb..c8fc05df5b1 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the title font. Note that the title's font used to be
customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/title/_pad.py b/packages/python/plotly/plotly/graph_objs/layout/title/_pad.py
index a64a32631c9..1b388f3ae61 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/title/_pad.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/title/_pad.py
@@ -17,7 +17,7 @@ def b(self):
"""
The amount of padding (in px) along the bottom of the
component.
-
+
The 'b' property is a number and may be specified as:
- An int or float
@@ -38,7 +38,7 @@ def l(self):
"""
The amount of padding (in px) on the left side of the
component.
-
+
The 'l' property is a number and may be specified as:
- An int or float
@@ -59,7 +59,7 @@ def r(self):
"""
The amount of padding (in px) on the right side of the
component.
-
+
The 'r' property is a number and may be specified as:
- An int or float
@@ -79,7 +79,7 @@ def r(self, val):
def t(self):
"""
The amount of padding (in px) along the top of the component.
-
+
The 't' property is a number and may be specified as:
- An int or float
@@ -115,7 +115,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs):
"""
Construct a new Pad object
-
+
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`
diff --git a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_button.py b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_button.py
index d7a40617e28..c1b002e982a 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_button.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_button.py
@@ -24,19 +24,19 @@ class Button(_BaseLayoutHierarchyType):
@property
def args(self):
"""
- Sets the arguments values to be passed to the Plotly method set
- in `method` on click.
-
- The 'args' property is an info array that may be specified as:
-
- * a list or tuple of up to 3 elements where:
- (0) The 'args[0]' property accepts values of any type
- (1) The 'args[1]' property accepts values of any type
- (2) The 'args[2]' property accepts values of any type
+ Sets the arguments values to be passed to the Plotly method set
+ in `method` on click.
- Returns
- -------
- list
+ The 'args' property is an info array that may be specified as:
+
+ * a list or tuple of up to 3 elements where:
+ (0) The 'args[0]' property accepts values of any type
+ (1) The 'args[1]' property accepts values of any type
+ (2) The 'args[2]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["args"]
@@ -49,20 +49,20 @@ def args(self, val):
@property
def args2(self):
"""
- Sets a 2nd set of `args`, these arguments values are passed to
- the Plotly method set in `method` when clicking this button
- while in the active state. Use this to create toggle buttons.
-
- The 'args2' property is an info array that may be specified as:
-
- * a list or tuple of up to 3 elements where:
- (0) The 'args2[0]' property accepts values of any type
- (1) The 'args2[1]' property accepts values of any type
- (2) The 'args2[2]' property accepts values of any type
+ Sets a 2nd set of `args`, these arguments values are passed to
+ the Plotly method set in `method` when clicking this button
+ while in the active state. Use this to create toggle buttons.
- Returns
- -------
- list
+ The 'args2' property is an info array that may be specified as:
+
+ * a list or tuple of up to 3 elements where:
+ (0) The 'args2[0]' property accepts values of any type
+ (1) The 'args2[1]' property accepts values of any type
+ (2) The 'args2[2]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["args2"]
@@ -82,7 +82,7 @@ def execute(self):
manually without losing the benefit of the updatemenu
automatically binding to the state of the plot through the
specification of `method` and `args`.
-
+
The 'execute' property must be specified as a bool
(either True, or False)
@@ -102,7 +102,7 @@ def execute(self, val):
def label(self):
"""
Sets the text label to appear on the button.
-
+
The 'label' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def method(self):
will perform no API calls and will not bind automatically to
state updates. This may be used to create a component interface
and attach to updatemenu events manually via JavaScript.
-
+
The 'method' property is an enumeration that may be specified as:
- One of the following enumeration values:
['restyle', 'relayout', 'animate', 'update', 'skip']
@@ -154,7 +154,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -203,7 +203,7 @@ def templateitemname(self, val):
def visible(self):
"""
Determines whether or not this button is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -286,7 +286,7 @@ def __init__(
):
"""
Construct a new Button object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_font.py b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_font.py
index f79696fa40d..ab1138cdf29 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the font of the update menu button text.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_pad.py b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_pad.py
index 880475fbae7..1ca6adc35fa 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_pad.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/updatemenu/_pad.py
@@ -17,7 +17,7 @@ def b(self):
"""
The amount of padding (in px) along the bottom of the
component.
-
+
The 'b' property is a number and may be specified as:
- An int or float
@@ -38,7 +38,7 @@ def l(self):
"""
The amount of padding (in px) on the left side of the
component.
-
+
The 'l' property is a number and may be specified as:
- An int or float
@@ -59,7 +59,7 @@ def r(self):
"""
The amount of padding (in px) on the right side of the
component.
-
+
The 'r' property is a number and may be specified as:
- An int or float
@@ -79,7 +79,7 @@ def r(self, val):
def t(self):
"""
The amount of padding (in px) along the top of the component.
-
+
The 't' property is a number and may be specified as:
- An int or float
@@ -115,7 +115,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs):
"""
Construct a new Pad object
-
+
Sets the padding around the buttons or dropdown menu.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangebreak.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangebreak.py
index 8a80af7c7de..4de4dc3f27f 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangebreak.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangebreak.py
@@ -23,18 +23,18 @@ class Rangebreak(_BaseLayoutHierarchyType):
@property
def bounds(self):
"""
- Sets the lower and upper bounds of this axis rangebreak. Can be
- used with `pattern`.
-
- The 'bounds' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'bounds[0]' property accepts values of any type
- (1) The 'bounds[1]' property accepts values of any type
+ Sets the lower and upper bounds of this axis rangebreak. Can be
+ used with `pattern`.
- Returns
- -------
- list
+ The 'bounds' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'bounds[0]' property accepts values of any type
+ (1) The 'bounds[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["bounds"]
@@ -49,7 +49,7 @@ def dvalue(self):
"""
Sets the size of each `values` item. The default is one day in
milliseconds.
-
+
The 'dvalue' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -70,7 +70,7 @@ def enabled(self):
"""
Determines whether this axis rangebreak is enabled or disabled.
Please note that `rangebreaks` only work for "date" axis type.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -96,7 +96,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -126,7 +126,7 @@ def pattern(self):
'mon'] } breaks from Saturday to Monday (i.e. skips the
weekends). - { pattern: 'hour', bounds: [17, 8] } breaks from
5pm to 8am (i.e. skips non-work hours).
-
+
The 'pattern' property is an enumeration that may be specified as:
- One of the following enumeration values:
['day of week', 'hour', '']
@@ -154,7 +154,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -177,7 +177,7 @@ def values(self):
Sets the coordinate values corresponding to the rangebreaks. An
alternative to `bounds`. Use `dvalue` to set the size of the
values along the axis.
-
+
The 'values' property is an info array that may be specified as:
* a list of elements where:
The 'values[i]' property accepts values of any type
@@ -258,7 +258,7 @@ def __init__(
):
"""
Construct a new Rangebreak object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeselector.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeselector.py
index 6202726327a..a5d72240f77 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeselector.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeselector.py
@@ -29,7 +29,7 @@ class Rangeselector(_BaseLayoutHierarchyType):
def activecolor(self):
"""
Sets the background color of the active range selector button.
-
+
The 'activecolor' 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)')
@@ -88,7 +88,7 @@ def activecolor(self, val):
def bgcolor(self):
"""
Sets the background color of the range selector buttons.
-
+
The '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)')
@@ -147,7 +147,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the color of the border enclosing the range selector.
-
+
The 'bordercolor' 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)')
@@ -207,7 +207,7 @@ def borderwidth(self):
"""
Sets the width (in px) of the border enclosing the range
selector.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -228,15 +228,15 @@ def buttons(self):
"""
Sets the specifications for each buttons. By default, a range
selector comes with no buttons.
-
+
The 'buttons' property is a tuple of instances of
Button that may be specified as:
- A list or tuple of instances of plotly.graph_objs.layout.xaxis.rangeselector.Button
- A list or tuple of dicts of string/value properties that
will be passed to the Button constructor
-
+
Supported dict properties:
-
+
count
Sets the number of steps to take to update the
range. Use with `step` to specify the update
@@ -302,13 +302,13 @@ def buttondefaults(self):
layout.template.layout.xaxis.rangeselector.buttondefaults),
sets the default property values to use for elements of
layout.xaxis.rangeselector.buttons
-
+
The 'buttondefaults' property is an instance of Button
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Button`
- A dict of string/value properties that will be passed
to the Button constructor
-
+
Supported dict properties:
Returns
@@ -327,17 +327,17 @@ def buttondefaults(self, val):
def font(self):
"""
Sets the font of the range selector button text.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.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
@@ -375,7 +375,7 @@ def visible(self):
Determines whether or not this range selector is visible. Note
that range selectors are only available for x axes of `type`
set to or auto-typed to "date".
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -396,7 +396,7 @@ def x(self):
"""
Sets the x position (in normalized coordinates) of the range
selector.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -418,7 +418,7 @@ def xanchor(self):
Sets the range selector's horizontal position anchor. This
anchor binds the `x` position to the "left", "center" or
"right" of the range selector.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'left', 'center', 'right']
@@ -440,7 +440,7 @@ def y(self):
"""
Sets the y position (in normalized coordinates) of the range
selector.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -462,7 +462,7 @@ def yanchor(self):
Sets the range selector's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the range selector.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'top', 'middle', 'bottom']
@@ -543,7 +543,7 @@ def __init__(
):
"""
Construct a new Rangeselector object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeslider.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeslider.py
index 738b575495a..5f8078e47fb 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeslider.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_rangeslider.py
@@ -27,7 +27,7 @@ def autorange(self):
Determines whether or not the range slider range is computed in
relation to the input data. If `range` is provided, then
`autorange` is set to False.
-
+
The 'autorange' property must be specified as a bool
(either True, or False)
@@ -47,7 +47,7 @@ def autorange(self, val):
def bgcolor(self):
"""
Sets the background color of the range slider.
-
+
The '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)')
@@ -106,7 +106,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the border color of the range slider.
-
+
The 'bordercolor' 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)')
@@ -165,7 +165,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the border width of the range slider.
-
+
The 'borderwidth' 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]
@@ -185,24 +185,24 @@ def borderwidth(self, val):
@property
def range(self):
"""
- Sets the range of the range slider. If not set, defaults to the
- full xaxis range. 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ Sets the range of the range slider. If not set, defaults to the
+ full xaxis range. 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -217,7 +217,7 @@ def thickness(self):
"""
The height of the range slider as a fraction of the total plot
area height.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -238,7 +238,7 @@ def visible(self):
"""
Determines whether or not the range slider will be visible. If
visible, perpendicular axes will be set to `fixedrange`
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -262,9 +262,9 @@ def yaxis(self):
- An instance of :class:`plotly.graph_objs.layout.xaxis.rangeslider.YAxis`
- A dict of string/value properties that will be passed
to the YAxis constructor
-
+
Supported dict properties:
-
+
range
Sets the range of this axis for the
rangeslider.
@@ -339,7 +339,7 @@ def __init__(
):
"""
Construct a new Rangeslider object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickfont.py
index 77fbd425b8d..be838c4dfca 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickformatstop.py
index 2366fadc435..a3d53a08e8b 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_title.py
index 878a98e73ef..2e996c9f2b6 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.xaxis.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
@@ -70,7 +70,7 @@ def standoff(self):
the set or default value. By setting `standoff` and turning on
`automargin`, plotly.js will push the margins to fit the axis
title at given standoff distance.
-
+
The 'standoff' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -92,7 +92,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -136,7 +136,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_button.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_button.py
index 9cd2ab2b1e3..8d51d2f50aa 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_button.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_button.py
@@ -25,7 +25,7 @@ def count(self):
"""
Sets the number of steps to take to update the range. Use with
`step` to specify the update interval.
-
+
The 'count' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -45,7 +45,7 @@ def count(self, val):
def label(self):
"""
Sets the text label to appear on the button.
-
+
The 'label' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -72,7 +72,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -94,7 +94,7 @@ def step(self):
"""
The unit of measurement that the `count` value will set the
range by.
-
+
The 'step' property is an enumeration that may be specified as:
- One of the following enumeration values:
['month', 'year', 'day', 'hour', 'minute', 'second',
@@ -124,7 +124,7 @@ def stepmode(self):
back to January 01 of the current year. Month and year "todate"
are currently available only for the built-in (Gregorian)
calendar.
-
+
The 'stepmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['backward', 'todate']
@@ -152,7 +152,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -173,7 +173,7 @@ def templateitemname(self, val):
def visible(self):
"""
Determines whether or not this button is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -248,7 +248,7 @@ def __init__(
):
"""
Construct a new Button object
-
+
Sets the specifications for each buttons. By default, a range
selector comes with no buttons.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_font.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_font.py
index 51fe9c34fbd..4885ff1f9a5 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeselector/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets the font of the range selector button text.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py
index c90f4ddb03a..88b56fcf69e 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py
@@ -15,17 +15,17 @@ class YAxis(_BaseLayoutHierarchyType):
@property
def range(self):
"""
- Sets the range of this axis for the rangeslider.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property accepts values of any type
- (1) The 'range[1]' property accepts values of any type
+ Sets the range of this axis for the rangeslider.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property accepts values of any type
+ (1) The 'range[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -43,7 +43,7 @@ def rangemode(self):
zooming in/out. If "auto", the autorange will be used. If
"fixed", the `range` is used. If "match", the current range of
the corresponding y-axis on the main subplot is used.
-
+
The 'rangemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'fixed', 'match']
@@ -77,7 +77,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, range=None, rangemode=None, **kwargs):
"""
Construct a new YAxis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/_font.py
index 3b38147116b..f173bdd4138 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/xaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_rangebreak.py b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_rangebreak.py
index 925bb9581e0..f5d900566c2 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_rangebreak.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_rangebreak.py
@@ -23,18 +23,18 @@ class Rangebreak(_BaseLayoutHierarchyType):
@property
def bounds(self):
"""
- Sets the lower and upper bounds of this axis rangebreak. Can be
- used with `pattern`.
-
- The 'bounds' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'bounds[0]' property accepts values of any type
- (1) The 'bounds[1]' property accepts values of any type
+ Sets the lower and upper bounds of this axis rangebreak. Can be
+ used with `pattern`.
- Returns
- -------
- list
+ The 'bounds' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'bounds[0]' property accepts values of any type
+ (1) The 'bounds[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["bounds"]
@@ -49,7 +49,7 @@ def dvalue(self):
"""
Sets the size of each `values` item. The default is one day in
milliseconds.
-
+
The 'dvalue' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -70,7 +70,7 @@ def enabled(self):
"""
Determines whether this axis rangebreak is enabled or disabled.
Please note that `rangebreaks` only work for "date" axis type.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -96,7 +96,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -126,7 +126,7 @@ def pattern(self):
'mon'] } breaks from Saturday to Monday (i.e. skips the
weekends). - { pattern: 'hour', bounds: [17, 8] } breaks from
5pm to 8am (i.e. skips non-work hours).
-
+
The 'pattern' property is an enumeration that may be specified as:
- One of the following enumeration values:
['day of week', 'hour', '']
@@ -154,7 +154,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -177,7 +177,7 @@ def values(self):
Sets the coordinate values corresponding to the rangebreaks. An
alternative to `bounds`. Use `dvalue` to set the size of the
values along the axis.
-
+
The 'values' property is an info array that may be specified as:
* a list of elements where:
The 'values[i]' property accepts values of any type
@@ -258,7 +258,7 @@ def __init__(
):
"""
Construct a new Rangebreak object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickfont.py b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickfont.py
index 6bcf211d301..66a6331cae6 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the tick font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickformatstop.py
index 932a83cc108..bbebefbf128 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseLayoutHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_title.py b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_title.py
index 3dc6078d5e2..abcd0b88712 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/yaxis/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/yaxis/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this axis' 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.yaxis.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
@@ -70,7 +70,7 @@ def standoff(self):
the set or default value. By setting `standoff` and turning on
`automargin`, plotly.js will push the margins to fit the axis
title at given standoff distance.
-
+
The 'standoff' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -92,7 +92,7 @@ def text(self):
Sets the title of this axis. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -136,7 +136,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/_font.py b/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/_font.py
index 0d2465fe064..7b9e3646d36 100644
--- a/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/layout/yaxis/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this axis' title font. Note that the title's font used to
be customized by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/_colorbar.py b/packages/python/plotly/plotly/graph_objs/mesh3d/_colorbar.py
index ff2612643b1..80cc76bf225 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.mesh3d.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.mesh3d.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
layout.template.data.mesh3d.colorbar.tickformatstopdefaults),
sets the default property values to use for elements of
mesh3d.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1109,17 +1109,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.mesh3d.colorbar.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
@@ -1141,7 +1141,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1158,14 +1158,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1179,7 +1179,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1201,7 +1201,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1222,7 +1222,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1242,7 +1242,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1264,7 +1264,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1285,7 +1285,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1554,7 +1554,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/_contour.py b/packages/python/plotly/plotly/graph_objs/mesh3d/_contour.py
index 554c7223bb2..b15ba60c70e 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/_contour.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/_contour.py
@@ -16,7 +16,7 @@ class Contour(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the contour lines.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def show(self):
"""
Sets whether or not dynamic contours are shown on hover
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -95,7 +95,7 @@ def show(self, val):
def width(self):
"""
Sets the width of the contour lines.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, show=None, width=None, **kwargs):
"""
Construct a new Contour object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/mesh3d/_hoverlabel.py
index eadebb70c4f..6ee33fa73d5 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.mesh3d.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/_lighting.py b/packages/python/plotly/plotly/graph_objs/mesh3d/_lighting.py
index e7e553d4142..591fa1aa1cf 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/_lighting.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/_lighting.py
@@ -25,7 +25,7 @@ def ambient(self):
"""
Ambient light increases overall color visibility but can wash
out the image.
-
+
The 'ambient' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -46,7 +46,7 @@ def diffuse(self):
"""
Represents the extent that incident rays are reflected in a
range of angles.
-
+
The 'diffuse' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -67,7 +67,7 @@ def facenormalsepsilon(self):
"""
Epsilon for face normals calculation avoids math issues arising
from degenerate geometry.
-
+
The 'facenormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -89,7 +89,7 @@ def fresnel(self):
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.
-
+
The 'fresnel' property is a number and may be specified as:
- An int or float in the interval [0, 5]
@@ -110,7 +110,7 @@ def roughness(self):
"""
Alters specular reflection; the rougher the surface, the wider
and less contrasty the shine.
-
+
The 'roughness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -131,7 +131,7 @@ def specular(self):
"""
Represents the level that incident rays are reflected in a
single direction, causing shine.
-
+
The 'specular' property is a number and may be specified as:
- An int or float in the interval [0, 2]
@@ -152,7 +152,7 @@ def vertexnormalsepsilon(self):
"""
Epsilon for vertex normals calculation avoids math issues
arising from degenerate geometry.
-
+
The 'vertexnormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -210,7 +210,7 @@ def __init__(
):
"""
Construct a new Lighting object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/_lightposition.py b/packages/python/plotly/plotly/graph_objs/mesh3d/_lightposition.py
index 5a7b354278d..2d23155eec4 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/_lightposition.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/_lightposition.py
@@ -16,7 +16,7 @@ class Lightposition(_BaseTraceHierarchyType):
def x(self):
"""
Numeric vector, representing the X coordinate for each vertex.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -36,7 +36,7 @@ def x(self, val):
def y(self):
"""
Numeric vector, representing the Y coordinate for each vertex.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -56,7 +56,7 @@ def y(self, val):
def z(self):
"""
Numeric vector, representing the Z coordinate for each vertex.
-
+
The 'z' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Lightposition object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/_stream.py b/packages/python/plotly/plotly/graph_objs/mesh3d/_stream.py
index cd33e6a8e77..777c4169b56 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickfont.py
index e700b3d9adb..f7e20e3113f 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py
index bbe75efc02f..fbe98f6a385 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_title.py
index f350b5d00b9..617f6987ed1 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.mesh3d.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/_font.py
index 39f898a66f3..89d5a9170b0 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/_font.py
index 200d87936aa..15178facb8f 100644
--- a/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/mesh3d/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/_decreasing.py b/packages/python/plotly/plotly/graph_objs/ohlc/_decreasing.py
index 44edb2b9fbd..3b1aa509459 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/_decreasing.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/_decreasing.py
@@ -20,9 +20,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.ohlc.decreasing.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color.
dash
@@ -56,7 +56,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, line=None, **kwargs):
"""
Construct a new Decreasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/ohlc/_hoverlabel.py
index b4e337ea3da..b8e52e91a0e 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/_hoverlabel.py
@@ -29,7 +29,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -51,7 +51,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -71,7 +71,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -131,7 +131,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -151,7 +151,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -212,7 +212,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -232,17 +232,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.ohlc.hoverlabel.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 .
@@ -267,7 +267,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -293,7 +293,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -316,7 +316,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -337,7 +337,7 @@ def split(self):
"""
Show hover information (open, close, high, low) in separate
labels.
-
+
The 'split' property must be specified as a bool
(either True, or False)
@@ -410,7 +410,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/_increasing.py b/packages/python/plotly/plotly/graph_objs/ohlc/_increasing.py
index 94adc4a072d..9ce1d33b91f 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/_increasing.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/_increasing.py
@@ -20,9 +20,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.ohlc.increasing.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color.
dash
@@ -56,7 +56,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, line=None, **kwargs):
"""
Construct a new Increasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/_line.py b/packages/python/plotly/plotly/graph_objs/ohlc/_line.py
index 86073d5833a..089880b2c72 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/_line.py
@@ -21,7 +21,7 @@ def dash(self):
"5px,10px,2px,2px"). Note that this style setting can also be
set per direction via `increasing.line.dash` and
`decreasing.line.dash`.
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -46,7 +46,7 @@ def width(self):
[object Object] Note that this style setting can also be set
per direction via `increasing.line.width` and
`decreasing.line.width`.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/_stream.py b/packages/python/plotly/plotly/graph_objs/ohlc/_stream.py
index 8bf7dfcd6dc..906b480e9b1 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/_line.py b/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/_line.py
index 259888b8ea7..9e3ebc1708b 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/decreasing/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -101,7 +101,7 @@ def dash(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -134,7 +134,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/_font.py
index 8f508de6314..c17abafd561 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/ohlc/increasing/_line.py b/packages/python/plotly/plotly/graph_objs/ohlc/increasing/_line.py
index 5dd576b168c..19a715e323e 100644
--- a/packages/python/plotly/plotly/graph_objs/ohlc/increasing/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/ohlc/increasing/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -101,7 +101,7 @@ def dash(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -134,7 +134,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/_dimension.py b/packages/python/plotly/plotly/graph_objs/parcats/_dimension.py
index e5fb559593b..1504de0ca08 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/_dimension.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/_dimension.py
@@ -29,7 +29,7 @@ def categoryarray(self):
Sets the order in which categories in this dimension appear.
Only has an effect if `categoryorder` is set to "array". Used
with `categoryorder`.
-
+
The 'categoryarray' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -50,7 +50,7 @@ def categoryarraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for
categoryarray .
-
+
The 'categoryarraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -80,7 +80,7 @@ def categoryorder(self):
for that attribute will be identical to the "trace" mode. The
unspecified categories will follow the categories in
`categoryarray`.
-
+
The 'categoryorder' property is an enumeration that may be specified as:
- One of the following enumeration values:
['trace', 'category ascending', 'category descending',
@@ -103,7 +103,7 @@ def displayindex(self):
"""
The display index of dimension, from left to right, zero
indexed, defaults to dimension index.
-
+
The 'displayindex' property is a integer and may be specified as:
- An int (or float that will be cast to an int)
@@ -123,7 +123,7 @@ def displayindex(self, val):
def label(self):
"""
The shown name of the dimension.
-
+
The 'label' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -147,7 +147,7 @@ def ticktext(self):
dimension. Only has an effect if `categoryorder` is set to
"array". Should be an array the same length as `categoryarray`
Used with `categoryorder`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -167,7 +167,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -190,7 +190,7 @@ def values(self):
the `n`th point in the dataset, therefore the `values` vector
for all dimensions must be the same (longer vectors will be
truncated).
-
+
The 'values' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -210,7 +210,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -231,7 +231,7 @@ def visible(self):
"""
Shows the dimension when set to `true` (the default). Hides the
dimension for `false`.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -313,7 +313,7 @@ def __init__(
):
"""
Construct a new Dimension object
-
+
The dimensions (variables) of the parallel categories diagram.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/_domain.py b/packages/python/plotly/plotly/graph_objs/parcats/_domain.py
index 5c1038ab75f..293382145a9 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this parcats trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this parcats trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this parcats trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this parcats trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this parcats trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this parcats trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/_labelfont.py b/packages/python/plotly/plotly/graph_objs/parcats/_labelfont.py
index 8054f77c1be..27bab29f46e 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/_labelfont.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/_labelfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Labelfont object
-
+
Sets the font for the `dimension` labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/_line.py b/packages/python/plotly/plotly/graph_objs/parcats/_line.py
index f6af41810eb..9e2eb224d41 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/_line.py
@@ -37,7 +37,7 @@ def autocolorscale(self):
`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)
@@ -61,7 +61,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -84,7 +84,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
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.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -247,9 +247,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.parcats.line.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
@@ -492,14 +492,14 @@ def colorscale(self):
be a palette name string of the following list: Greys,YlGnBu,Gr
eens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet
,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -535,7 +535,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -574,7 +574,7 @@ def hovertemplate(self):
is displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -598,7 +598,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -620,7 +620,7 @@ def shape(self):
Sets the shape of the paths. If `linear`, paths are composed of
straight lines. If `hspline`, paths are composed of horizontal
curved splines
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'hspline']
@@ -643,7 +643,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -788,7 +788,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/_stream.py b/packages/python/plotly/plotly/graph_objs/parcats/_stream.py
index f0004d27a44..73368a9b905 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/_tickfont.py b/packages/python/plotly/plotly/graph_objs/parcats/_tickfont.py
index 14fabfcc582..17357e6cc3c 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the font for the `category` labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/_colorbar.py b/packages/python/plotly/plotly/graph_objs/parcats/line/_colorbar.py
index 6a2ad0993ff..3e513cf0e5b 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/line/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/line/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.parcats.line.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.parcats.line.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
olorbar.tickformatstopdefaults), sets the default property
values to use for elements of
parcats.line.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.parcats.line.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickfont.py
index a01498569ef..7e7045f83e5 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py
index 396a7ef3818..0705a459f3d 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_title.py
index 1ce45d48940..f515cae1547 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.parcats.line.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/_font.py
index c49b9879b7f..1c9f3da206a 100644
--- a/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/parcats/line/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/_dimension.py b/packages/python/plotly/plotly/graph_objs/parcoords/_dimension.py
index 9237241aa53..36be84678fc 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/_dimension.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/_dimension.py
@@ -30,29 +30,29 @@ class Dimension(_BaseTraceHierarchyType):
@property
def constraintrange(self):
"""
- 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]`.
-
- The 'constraintrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'constraintrange[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'constraintrange[1]' property is a number and may be specified as:
- - An int or float
-
- * a 2D list where:
- (0) The 'constraintrange[i][0]' property is a number and may be specified as:
- - An int or float
- (1) The 'constraintrange[i][1]' property is a number and may be specified as:
- - An int or float
-
- Returns
- -------
- list
+ 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]`.
+
+ The 'constraintrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'constraintrange[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'constraintrange[1]' property is a number and may be specified as:
+ - An int or float
+
+ * a 2D list where:
+ (0) The 'constraintrange[i][0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'constraintrange[i][1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["constraintrange"]
@@ -66,7 +66,7 @@ def constraintrange(self, val):
def label(self):
"""
The shown name of the dimension.
-
+
The 'label' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -87,7 +87,7 @@ def label(self, val):
def multiselect(self):
"""
Do we allow multiple selection ranges or just a single range?
-
+
The 'multiselect' property must be specified as a bool
(either True, or False)
@@ -113,7 +113,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -133,21 +133,21 @@ def name(self, val):
@property
def range(self):
"""
- 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.
-
- The 'range' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'range[0]' property is a number and may be specified as:
- - An int or float
- (1) The 'range[1]' property is a number and may be specified as:
- - An int or float
+ 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.
- Returns
- -------
- list
+ The 'range' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'range[0]' property is a number and may be specified as:
+ - An int or float
+ (1) The 'range[1]' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ list
"""
return self["range"]
@@ -168,7 +168,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -196,7 +196,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -217,7 +217,7 @@ def tickformat(self, val):
def ticktext(self):
"""
Sets the text displayed at the ticks position via `tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -237,7 +237,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -257,7 +257,7 @@ def ticktextsrc(self, val):
def tickvals(self):
"""
Sets the values at which ticks on this axis appear.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -277,7 +277,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -300,7 +300,7 @@ def values(self):
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.
-
+
The 'values' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -320,7 +320,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -341,7 +341,7 @@ def visible(self):
"""
Shows the dimension when set to `true` (the default). Hides the
dimension for `false`.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -453,7 +453,7 @@ def __init__(
):
"""
Construct a new Dimension object
-
+
The dimensions (variables) of the parallel coordinates chart.
2..60 dimensions are supported.
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/_domain.py b/packages/python/plotly/plotly/graph_objs/parcoords/_domain.py
index c62ee789c9f..0645887c8f3 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this parcoords trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this parcoords trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this parcoords trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this parcoords trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this parcoords trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this parcoords trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/_labelfont.py b/packages/python/plotly/plotly/graph_objs/parcoords/_labelfont.py
index ef655015bfc..719cfacd30f 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/_labelfont.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/_labelfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Labelfont object
-
+
Sets the font for the `dimension` labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/_line.py b/packages/python/plotly/plotly/graph_objs/parcoords/_line.py
index 546312ec9e3..43ae8d0e38e 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`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)
@@ -59,7 +59,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -82,7 +82,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -106,7 +106,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -129,7 +129,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -152,7 +152,7 @@ def color(self):
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.
-
+
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)')
@@ -219,7 +219,7 @@ def coloraxis(self):
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
@@ -245,9 +245,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.parcoords.line.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
@@ -490,14 +490,14 @@ def colorscale(self):
be a palette name string of the following list: Greys,YlGnBu,Gr
eens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet
,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -533,7 +533,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -556,7 +556,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -578,7 +578,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -694,7 +694,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/_rangefont.py b/packages/python/plotly/plotly/graph_objs/parcoords/_rangefont.py
index fe9d045bdb1..0e081fda8f4 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/_rangefont.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/_rangefont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Rangefont object
-
+
Sets the font for the `dimension` range values.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/_stream.py b/packages/python/plotly/plotly/graph_objs/parcoords/_stream.py
index b621fcaa56a..0d15bbaa005 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/_tickfont.py b/packages/python/plotly/plotly/graph_objs/parcoords/_tickfont.py
index 459a52a9a68..8d0241ac22f 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the font for the `dimension` tick values.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/_colorbar.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/_colorbar.py
index 257f038abfb..7f2a0b4de24 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/line/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.parcoords.line.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
parcoords.line.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.parcoords.line.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py
index b424df53707..6e11aaaf61b 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py
index a9c0fe3bb11..8321effa519 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_title.py
index 8b7d9295527..60638c9d474 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.parcoords.line.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/_font.py
index a2775d5978d..798c9f2e62e 100644
--- a/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/parcoords/line/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_domain.py b/packages/python/plotly/plotly/graph_objs/pie/_domain.py
index e1d9982b6c6..467a3ff0cea 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this pie trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this pie trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this pie trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this pie trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,19 +85,19 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this pie trace (in plot fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this pie trace (in plot fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/pie/_hoverlabel.py
index 8c51478ffbb..ac102a65b5e 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.pie.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_insidetextfont.py b/packages/python/plotly/plotly/graph_objs/pie/_insidetextfont.py
index 0943d93a490..28eaccfc456 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_insidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_insidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Insidetextfont object
-
+
Sets the font used for `textinfo` lying inside the sector.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_marker.py b/packages/python/plotly/plotly/graph_objs/pie/_marker.py
index e6d4955c53e..850bfb5867c 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_marker.py
@@ -17,7 +17,7 @@ def colors(self):
"""
Sets the color of each sector. If not specified, the default
trace color set is used to pick the sector colors.
-
+
The 'colors' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -37,7 +37,7 @@ def colors(self, val):
def colorssrc(self):
"""
Sets the source reference on Chart Studio Cloud for colors .
-
+
The 'colorssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -61,9 +61,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.pie.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the line enclosing each
sector.
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, colors=None, colorssrc=None, line=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_outsidetextfont.py b/packages/python/plotly/plotly/graph_objs/pie/_outsidetextfont.py
index 72bef9fb247..4f4ceb92ba5 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_outsidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_outsidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Outsidetextfont object
-
+
Sets the font used for `textinfo` lying outside the sector.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_stream.py b/packages/python/plotly/plotly/graph_objs/pie/_stream.py
index ebe0819bde4..09f3f41e1af 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_textfont.py b/packages/python/plotly/plotly/graph_objs/pie/_textfont.py
index cd466e36669..79fab1481bf 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used for `textinfo`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/pie/_title.py b/packages/python/plotly/plotly/graph_objs/pie/_title.py
index b582f6688c7..82be5d01e3f 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
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 .
@@ -52,7 +52,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -75,7 +75,7 @@ def position(self):
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',
@@ -100,7 +100,7 @@ def text(self):
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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -139,7 +139,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, position=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/_font.py
index 5f658e6c205..4d61e0736cd 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/pie/marker/_line.py b/packages/python/plotly/plotly/graph_objs/pie/marker/_line.py
index 90ae6f78011..33841386f7d 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/marker/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the line enclosing each sector.
-
+
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)')
@@ -76,7 +76,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the line enclosing each sector.
-
+
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
@@ -117,7 +117,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -154,7 +154,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pie/title/_font.py b/packages/python/plotly/plotly/graph_objs/pie/title/_font.py
index 7115c3b4634..fb000df59d6 100644
--- a/packages/python/plotly/plotly/graph_objs/pie/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/pie/title/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used for `title`. Note that the title's font used
to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/pointcloud/_hoverlabel.py
index 51e9c2daf5a..b5da4130141 100644
--- a/packages/python/plotly/plotly/graph_objs/pointcloud/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/pointcloud/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.pointcloud.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/_marker.py b/packages/python/plotly/plotly/graph_objs/pointcloud/_marker.py
index c6c5c6d761f..d3bd9b6acee 100644
--- a/packages/python/plotly/plotly/graph_objs/pointcloud/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/pointcloud/_marker.py
@@ -19,7 +19,7 @@ def blend(self):
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.
-
+
The 'blend' property must be specified as a bool
(either True, or False)
@@ -43,9 +43,9 @@ def border(self):
- An instance of :class:`plotly.graph_objs.pointcloud.marker.Border`
- A dict of string/value properties that will be passed
to the Border constructor
-
+
Supported dict properties:
-
+
arearatio
Specifies what fraction of the marker area is
covered with the border.
@@ -73,7 +73,7 @@ def color(self):
Sets the marker fill color. It accepts a specific color.If the
color is not fully opaque and there are hundreds of thousandsof
points, it may cause slower zooming and panning.
-
+
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)')
@@ -136,7 +136,7 @@ def opacity(self):
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.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -157,7 +157,7 @@ def sizemax(self):
"""
Sets the maximum size (in px) of the rendered marker points.
Effective when the `pointcloud` shows only few points.
-
+
The 'sizemax' property is a number and may be specified as:
- An int or float in the interval [0.1, inf]
@@ -178,7 +178,7 @@ def sizemin(self):
"""
Sets the minimum size (in px) of the rendered marker points,
effective when the `pointcloud` shows a million or more points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0.1, 2]
@@ -240,7 +240,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/_stream.py b/packages/python/plotly/plotly/graph_objs/pointcloud/_stream.py
index 14a1251f92b..00278df8741 100644
--- a/packages/python/plotly/plotly/graph_objs/pointcloud/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/pointcloud/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/_font.py
index 10040c2e486..634110a5019 100644
--- a/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/pointcloud/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/pointcloud/marker/_border.py b/packages/python/plotly/plotly/graph_objs/pointcloud/marker/_border.py
index 936a402318f..d77ce13be20 100644
--- a/packages/python/plotly/plotly/graph_objs/pointcloud/marker/_border.py
+++ b/packages/python/plotly/plotly/graph_objs/pointcloud/marker/_border.py
@@ -17,7 +17,7 @@ def arearatio(self):
"""
Specifies what fraction of the marker area is covered with the
border.
-
+
The 'arearatio' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -39,7 +39,7 @@ def color(self):
Sets the stroke 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.
-
+
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)')
@@ -110,7 +110,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, arearatio=None, color=None, **kwargs):
"""
Construct a new Border object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/_domain.py b/packages/python/plotly/plotly/graph_objs/sankey/_domain.py
index e145ab149ee..7e557437117 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this sankey trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this sankey trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this sankey trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this sankey trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this sankey trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this sankey trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/sankey/_hoverlabel.py
index 1d20d0d0d7b..12126928bab 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.sankey.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/_link.py b/packages/python/plotly/plotly/graph_objs/sankey/_link.py
index 191a96dae0d..81d2fcefc93 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/_link.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/_link.py
@@ -38,7 +38,7 @@ def color(self):
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.
-
+
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)')
@@ -102,9 +102,9 @@ def colorscales(self):
- A list or tuple of instances of plotly.graph_objs.sankey.link.Colorscale
- A list or tuple of dicts of string/value properties that
will be passed to the Colorscale constructor
-
+
Supported dict properties:
-
+
cmax
Sets the upper bound of the color domain.
cmin
@@ -167,13 +167,13 @@ def colorscaledefaults(self):
layout.template.data.sankey.link.colorscaledefaults), sets the
default property values to use for elements of
sankey.link.colorscales
-
+
The 'colorscaledefaults' property is an instance of Colorscale
that may be specified as:
- An instance of :class:`plotly.graph_objs.sankey.link.Colorscale`
- A dict of string/value properties that will be passed
to the Colorscale constructor
-
+
Supported dict properties:
Returns
@@ -192,7 +192,7 @@ def colorscaledefaults(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -212,7 +212,7 @@ def colorsrc(self, val):
def customdata(self):
"""
Assigns extra data to each link.
-
+
The 'customdata' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -233,7 +233,7 @@ def customdatasrc(self):
"""
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
@@ -256,7 +256,7 @@ def hoverinfo(self):
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 an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'none', 'skip']
@@ -281,9 +281,9 @@ def hoverlabel(self):
- An instance of :class:`plotly.graph_objs.sankey.link.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
@@ -355,7 +355,7 @@ def hovertemplate(self):
displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -378,7 +378,7 @@ def hovertemplatesrc(self):
"""
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
@@ -398,7 +398,7 @@ def hovertemplatesrc(self, val):
def label(self):
"""
The shown name of the link.
-
+
The 'label' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -418,7 +418,7 @@ def label(self, val):
def labelsrc(self):
"""
Sets the source reference on Chart Studio Cloud for label .
-
+
The 'labelsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -442,9 +442,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.sankey.link.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the `line` around each
`link`.
@@ -475,7 +475,7 @@ def source(self):
"""
An integer number `[0..nodes.length - 1]` that represents the
source node.
-
+
The 'source' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -495,7 +495,7 @@ def source(self, val):
def sourcesrc(self):
"""
Sets the source reference on Chart Studio Cloud for source .
-
+
The 'sourcesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -516,7 +516,7 @@ def target(self):
"""
An integer number `[0..nodes.length - 1]` that represents the
target node.
-
+
The 'target' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -536,7 +536,7 @@ def target(self, val):
def targetsrc(self):
"""
Sets the source reference on Chart Studio Cloud for target .
-
+
The 'targetsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -556,7 +556,7 @@ def targetsrc(self, val):
def value(self):
"""
A numeric value representing the flow volume value.
-
+
The 'value' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -576,7 +576,7 @@ def value(self, val):
def valuesrc(self):
"""
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
@@ -704,7 +704,7 @@ def __init__(
):
"""
Construct a new Link object
-
+
The links of the Sankey plot.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/_node.py b/packages/python/plotly/plotly/graph_objs/sankey/_node.py
index 49213bcf20b..5d64a0730c3 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/_node.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/_node.py
@@ -40,7 +40,7 @@ def color(self):
through to have a variety of colors. These defaults are not
fully opaque, to allow some visibility of what is beneath the
node.
-
+
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)')
@@ -100,7 +100,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -120,7 +120,7 @@ def colorsrc(self, val):
def customdata(self):
"""
Assigns extra data to each node.
-
+
The 'customdata' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -141,7 +141,7 @@ def customdatasrc(self):
"""
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
@@ -163,7 +163,7 @@ def groups(self):
Groups of nodes. Each group is defined by an array with the
indices of the nodes it contains. Multiple groups can be
specified.
-
+
The 'groups' property is an info array that may be specified as:
* a 2D list where:
The 'groups[i][j]' property is a number and may be specified as:
@@ -188,7 +188,7 @@ def hoverinfo(self):
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 an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'none', 'skip']
@@ -213,9 +213,9 @@ def hoverlabel(self):
- An instance of :class:`plotly.graph_objs.sankey.node.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
@@ -287,7 +287,7 @@ def hovertemplate(self):
displayed in the secondary box, for example
"{fullData.name}". To hide the secondary box
completely, use an empty tag ``.
-
+
The 'hovertemplate' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -310,7 +310,7 @@ def hovertemplatesrc(self):
"""
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
@@ -330,7 +330,7 @@ def hovertemplatesrc(self, val):
def label(self):
"""
The shown name of the node.
-
+
The 'label' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -350,7 +350,7 @@ def label(self, val):
def labelsrc(self):
"""
Sets the source reference on Chart Studio Cloud for label .
-
+
The 'labelsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -374,9 +374,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.sankey.node.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the `line` around each
`node`.
@@ -406,7 +406,7 @@ def line(self, val):
def pad(self):
"""
Sets the padding (in px) between the `nodes`.
-
+
The 'pad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -426,7 +426,7 @@ def pad(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the `nodes`.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [1, inf]
@@ -446,7 +446,7 @@ def thickness(self, val):
def x(self):
"""
The normalized horizontal position of the node.
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -466,7 +466,7 @@ def x(self, val):
def xsrc(self):
"""
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
@@ -486,7 +486,7 @@ def xsrc(self, val):
def y(self):
"""
The normalized vertical position of the node.
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -506,7 +506,7 @@ def y(self, val):
def ysrc(self):
"""
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
@@ -627,7 +627,7 @@ def __init__(
):
"""
Construct a new Node object
-
+
The nodes of the Sankey plot.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/_stream.py b/packages/python/plotly/plotly/graph_objs/sankey/_stream.py
index 6b13ba98105..d0d3ca96df8 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/_textfont.py b/packages/python/plotly/plotly/graph_objs/sankey/_textfont.py
index 473b1177395..5d3aa840108 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/_textfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Textfont object
-
+
Sets the font for node labels
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/_font.py
index ccd2b880a30..05a79812e8e 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/link/_colorscale.py b/packages/python/plotly/plotly/graph_objs/sankey/link/_colorscale.py
index f9a39780694..91616ae6dee 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/link/_colorscale.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/link/_colorscale.py
@@ -16,7 +16,7 @@ class Colorscale(_BaseTraceHierarchyType):
def cmax(self):
"""
Sets the upper bound of the color domain.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -36,7 +36,7 @@ def cmax(self, val):
def cmin(self):
"""
Sets the lower bound of the color domain.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -65,14 +65,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -109,7 +109,7 @@ def label(self):
"""
The label of the links to color based on their concentration
within a flow.
-
+
The 'label' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -136,7 +136,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -164,7 +164,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -237,7 +237,7 @@ def __init__(
):
"""
Construct a new Colorscale object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/link/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/sankey/link/_hoverlabel.py
index 8178c1d0b5f..ad9ae03fb13 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/link/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/link/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/link/_line.py b/packages/python/plotly/plotly/graph_objs/sankey/link/_line.py
index 7fe9d97522d..f317ce069da 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/link/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/link/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the `line` around each `link`.
-
+
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)')
@@ -76,7 +76,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the `line` around each `link`.
-
+
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
@@ -117,7 +117,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -154,7 +154,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/_font.py
index feb7f6efa29..cbc041e88d2 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/link/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/node/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/sankey/node/_hoverlabel.py
index 7334939ce17..6e7852f0d4d 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/node/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/node/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.sankey.node.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/node/_line.py b/packages/python/plotly/plotly/graph_objs/sankey/node/_line.py
index 03cad169193..5c7d76d96e5 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/node/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/node/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the `line` around each `node`.
-
+
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)')
@@ -76,7 +76,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the `line` around each `node`.
-
+
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
@@ -117,7 +117,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -154,7 +154,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/_font.py
index a2ec6e83b25..79c90314c7b 100644
--- a/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/sankey/node/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_error_x.py b/packages/python/plotly/plotly/graph_objs/scatter/_error_x.py
index e966aae4df5..0fb5f46522d 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_error_x.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_error_x.py
@@ -33,7 +33,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -55,7 +55,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -76,7 +76,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -116,7 +116,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -195,7 +195,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -215,7 +215,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -279,7 +279,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -302,7 +302,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -325,7 +325,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -345,7 +345,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -366,7 +366,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -464,7 +464,7 @@ def __init__(
):
"""
Construct a new ErrorX object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_error_y.py b/packages/python/plotly/plotly/graph_objs/scatter/_error_y.py
index f983bb6c3d1..0bfe1b8f89d 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_error_y.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_error_y.py
@@ -32,7 +32,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -54,7 +54,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -75,7 +75,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -95,7 +95,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -115,7 +115,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -176,7 +176,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -196,7 +196,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -260,7 +260,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -283,7 +283,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -306,7 +306,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -326,7 +326,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -347,7 +347,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -442,7 +442,7 @@ def __init__(
):
"""
Construct a new ErrorY object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scatter/_hoverlabel.py
index 5b617a53044..98321eefbdf 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_line.py b/packages/python/plotly/plotly/graph_objs/scatter/_line.py
index fc8342c1e35..48a7734297e 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -103,7 +103,7 @@ def shape(self):
Determines the line shape. With "spline" the lines are drawn
using spline interpolation. The other available values
correspond to step-wise line shapes.
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'spline', 'hv', 'vh', 'hvh', 'vhv']
@@ -127,7 +127,7 @@ def simplify(self):
transitioning lines, it may be desirable to disable this so
that the number of points along the resulting SVG path is
unaffected.
-
+
The 'simplify' property must be specified as a bool
(either True, or False)
@@ -149,7 +149,7 @@ def smoothing(self):
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).
-
+
The 'smoothing' property is a number and may be specified as:
- An int or float in the interval [0, 1.3]
@@ -169,7 +169,7 @@ def smoothing(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -225,7 +225,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_marker.py b/packages/python/plotly/plotly/graph_objs/scatter/_marker.py
index 8520b90cc21..f8b85a2c4d0 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_marker.py
@@ -47,7 +47,7 @@ def autocolorscale(self):
or `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)
@@ -72,7 +72,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -95,7 +95,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -119,7 +119,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -142,7 +142,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -165,7 +165,7 @@ def color(self):
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.
-
+
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)')
@@ -232,7 +232,7 @@ def coloraxis(self):
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
@@ -258,9 +258,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scatter.marker.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
@@ -503,14 +503,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -546,7 +546,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -570,9 +570,9 @@ def gradient(self):
- An instance of :class:`plotly.graph_objs.scatter.marker.Gradient`
- A dict of string/value properties that will be passed
to the Gradient constructor
-
+
Supported dict properties:
-
+
color
Sets the final color of the gradient fill: the
center color for radial, the right for
@@ -607,9 +607,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scatter.marker.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
@@ -716,7 +716,7 @@ def maxdisplayed(self):
"""
Sets a maximum number of points to be drawn on the graph. 0
corresponds to no limit.
-
+
The 'maxdisplayed' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -736,7 +736,7 @@ def maxdisplayed(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -757,7 +757,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -780,7 +780,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -802,7 +802,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -822,7 +822,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -845,7 +845,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -867,7 +867,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -890,7 +890,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -910,7 +910,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -933,7 +933,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -1041,7 +1041,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1210,7 +1210,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_selected.py b/packages/python/plotly/plotly/graph_objs/scatter/_selected.py
index 103569abf4f..e421b3418ab 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatter.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatter.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_stream.py b/packages/python/plotly/plotly/graph_objs/scatter/_stream.py
index b284f1c228e..e4c575e58f6 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatter/_textfont.py
index 7785d70fcd2..975cdf020ac 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/_unselected.py b/packages/python/plotly/plotly/graph_objs/scatter/_unselected.py
index d2a71614290..39e98a5f915 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatter.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -53,9 +53,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatter.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -86,7 +86,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/_font.py
index dbcde88b143..e6130af66a3 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/_colorbar.py
index a4f3def1ba0..63d39a1288f 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scatter.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
scatter.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scatter.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/_gradient.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/_gradient.py
index 6ff1a871489..1c3ff103146 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/marker/_gradient.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/_gradient.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the final color of the gradient fill: the center color for
radial, the right for horizontal, or the bottom for vertical.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def type(self):
"""
Sets the type of gradient used to fill the markers
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['radial', 'horizontal', 'vertical', 'none']
@@ -119,7 +119,7 @@ def type(self, val):
def typesrc(self):
"""
Sets the source reference on Chart Studio Cloud for type .
-
+
The 'typesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -157,7 +157,7 @@ def __init__(
):
"""
Construct a new Gradient object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/_line.py
index 39b5b865891..7f40c51f33f 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py
index b60bfa7f7ef..5fe1222f918 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py
index 0f1bd1574da..6bef83f6e40 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_title.py
index 29f023d4e91..94c23177177 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scatter.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/_font.py
index 3c7d1ca13e2..d0eb0ac7f3c 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatter/selected/_marker.py
index eebffe8bbda..a727424cc18 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatter/selected/_textfont.py
index 0018410725e..e47dcd5e587 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatter/unselected/_marker.py
index 97101611b5e..087bdee6d67 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatter/unselected/_textfont.py
index 629dc262aa2..e6e30aa5a1a 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_error_x.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_error_x.py
index b63edab32b3..fec084d5528 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_error_x.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_error_x.py
@@ -33,7 +33,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -55,7 +55,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -76,7 +76,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -116,7 +116,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -195,7 +195,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -215,7 +215,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -279,7 +279,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -302,7 +302,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -325,7 +325,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -345,7 +345,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -366,7 +366,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -464,7 +464,7 @@ def __init__(
):
"""
Construct a new ErrorX object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_error_y.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_error_y.py
index 861d206c520..364ea8f1663 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_error_y.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_error_y.py
@@ -33,7 +33,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -55,7 +55,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -76,7 +76,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -116,7 +116,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -195,7 +195,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -215,7 +215,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -279,7 +279,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -302,7 +302,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -325,7 +325,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -345,7 +345,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -366,7 +366,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -464,7 +464,7 @@ def __init__(
):
"""
Construct a new ErrorY object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_error_z.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_error_z.py
index 15acac85b48..974352b773a 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_error_z.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_error_z.py
@@ -32,7 +32,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -54,7 +54,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -75,7 +75,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -95,7 +95,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -115,7 +115,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -176,7 +176,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -196,7 +196,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -260,7 +260,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -283,7 +283,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -306,7 +306,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -326,7 +326,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -347,7 +347,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -442,7 +442,7 @@ def __init__(
):
"""
Construct a new ErrorZ object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_hoverlabel.py
index 66e7cc8cf3f..dc2bfc1d706 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter3d.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_line.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_line.py
index 8f07ea47a00..b149f135228 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_line.py
@@ -37,7 +37,7 @@ def autocolorscale(self):
`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)
@@ -61,7 +61,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -84,7 +84,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
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.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -247,9 +247,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scatter3d.line.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
@@ -492,14 +492,14 @@ def colorscale(self):
be a palette name string of the following list: Greys,YlGnBu,Gr
eens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet
,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -535,7 +535,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -555,7 +555,7 @@ def colorsrc(self, val):
def dash(self):
"""
Sets the dash style of the lines.
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following enumeration values:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -580,7 +580,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -602,7 +602,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -622,7 +622,7 @@ def showscale(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -744,7 +744,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_marker.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_marker.py
index 6c5c07af03b..7407d3d5dbc 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_marker.py
@@ -44,7 +44,7 @@ def autocolorscale(self):
or `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)
@@ -69,7 +69,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -92,7 +92,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -116,7 +116,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -139,7 +139,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -162,7 +162,7 @@ def color(self):
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.
-
+
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)')
@@ -229,7 +229,7 @@ def coloraxis(self):
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
@@ -255,9 +255,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scatter3d.marker.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
@@ -500,14 +500,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -543,7 +543,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -567,9 +567,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scatter3d.marker.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
@@ -676,7 +676,7 @@ def opacity(self):
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.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -699,7 +699,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -721,7 +721,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -741,7 +741,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -764,7 +764,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -786,7 +786,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -809,7 +809,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -829,7 +829,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -849,7 +849,7 @@ def sizesrc(self, val):
def symbol(self):
"""
Sets the marker symbol type.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
['circle', 'circle-open', 'square', 'square-open',
@@ -872,7 +872,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1029,7 +1029,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_projection.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_projection.py
index ca61d852644..7c5fad705c8 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_projection.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_projection.py
@@ -20,9 +20,9 @@ def x(self):
- An instance of :class:`plotly.graph_objs.scatter3d.projection.X`
- A dict of string/value properties that will be passed
to the X constructor
-
+
Supported dict properties:
-
+
opacity
Sets the projection color.
scale
@@ -52,9 +52,9 @@ def y(self):
- An instance of :class:`plotly.graph_objs.scatter3d.projection.Y`
- A dict of string/value properties that will be passed
to the Y constructor
-
+
Supported dict properties:
-
+
opacity
Sets the projection color.
scale
@@ -84,9 +84,9 @@ def z(self):
- An instance of :class:`plotly.graph_objs.scatter3d.projection.Z`
- A dict of string/value properties that will be passed
to the Z constructor
-
+
Supported dict properties:
-
+
opacity
Sets the projection color.
scale
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Projection object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_stream.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_stream.py
index 9181495a458..10dc5f9c6e9 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatter3d/_textfont.py
index 790591255c8..748879ff898 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -201,7 +201,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/_font.py
index ff2c7e880a6..bdfb30c6e13 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/_colorbar.py
index 69d7ee55d87..338bd83877e 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
scatter3d.line.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scatter3d.line.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py
index b49ff81abdb..0b8a32e2aec 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py
index 22f66f06460..48f413bd35c 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_title.py
index 41260d911e2..3e07d2a46e3 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scatter3d.line.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py
index 481239e5cf2..7091264dd59 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_colorbar.py
index 3dbab7ca782..4949e16978e 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
er.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
scatter3d.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scatter3d.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1556,7 +1556,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_line.py
index cb0b60feb5f..7c23c6cb5a0 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/_line.py
@@ -34,7 +34,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -59,7 +59,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -82,7 +82,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -107,7 +107,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -130,7 +130,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -153,7 +153,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -220,7 +220,7 @@ def coloraxis(self):
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
@@ -253,14 +253,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -296,7 +296,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -320,7 +320,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -340,7 +340,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -455,7 +455,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py
index 88483bc29ad..439de8e6b3d 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py
index 38c3bdeefc3..83208cac32f 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_title.py
index 05af447cd16..fdb4dcb7bff 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scatter3d.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py
index 452c4619ae6..2aa452a23ce 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_x.py b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_x.py
index f81592da031..3a83449aad0 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_x.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_x.py
@@ -16,7 +16,7 @@ class X(_BaseTraceHierarchyType):
def opacity(self):
"""
Sets the projection color.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -37,7 +37,7 @@ def scale(self):
"""
Sets the scale factor determining the size of the projection
marker points.
-
+
The 'scale' property is a number and may be specified as:
- An int or float in the interval [0, 10]
@@ -57,7 +57,7 @@ def scale(self, val):
def show(self):
"""
Sets whether or not projections are shown along the x axis.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs):
"""
Construct a new X object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_y.py b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_y.py
index 18161582870..78816376bac 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_y.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_y.py
@@ -16,7 +16,7 @@ class Y(_BaseTraceHierarchyType):
def opacity(self):
"""
Sets the projection color.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -37,7 +37,7 @@ def scale(self):
"""
Sets the scale factor determining the size of the projection
marker points.
-
+
The 'scale' property is a number and may be specified as:
- An int or float in the interval [0, 10]
@@ -57,7 +57,7 @@ def scale(self, val):
def show(self):
"""
Sets whether or not projections are shown along the y axis.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs):
"""
Construct a new Y object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_z.py b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_z.py
index adb8a40aee3..92a6ff8929a 100644
--- a/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_z.py
+++ b/packages/python/plotly/plotly/graph_objs/scatter3d/projection/_z.py
@@ -16,7 +16,7 @@ class Z(_BaseTraceHierarchyType):
def opacity(self):
"""
Sets the projection color.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -37,7 +37,7 @@ def scale(self):
"""
Sets the scale factor determining the size of the projection
marker points.
-
+
The 'scale' property is a number and may be specified as:
- An int or float in the interval [0, 10]
@@ -57,7 +57,7 @@ def scale(self, val):
def show(self):
"""
Sets whether or not projections are shown along the z axis.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs):
"""
Construct a new Z object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/_hoverlabel.py
index a28b67dc0fa..10ae394e17f 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattercarpet.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/_line.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/_line.py
index c093cecb38f..fffd668ccce 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -103,7 +103,7 @@ def shape(self):
Determines the line shape. With "spline" the lines are drawn
using spline interpolation. The other available values
correspond to step-wise line shapes.
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'spline']
@@ -126,7 +126,7 @@ def smoothing(self):
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).
-
+
The 'smoothing' property is a number and may be specified as:
- An int or float in the interval [0, 1.3]
@@ -146,7 +146,7 @@ def smoothing(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -196,7 +196,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/_marker.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/_marker.py
index e9aed8ae36e..de4bb9bc52e 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/_marker.py
@@ -47,7 +47,7 @@ def autocolorscale(self):
or `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)
@@ -72,7 +72,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -95,7 +95,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -119,7 +119,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -142,7 +142,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -165,7 +165,7 @@ def color(self):
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.
-
+
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)')
@@ -232,7 +232,7 @@ def coloraxis(self):
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
@@ -258,9 +258,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.marker.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
@@ -503,14 +503,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -546,7 +546,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -570,9 +570,9 @@ def gradient(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.marker.Gradient`
- A dict of string/value properties that will be passed
to the Gradient constructor
-
+
Supported dict properties:
-
+
color
Sets the final color of the gradient fill: the
center color for radial, the right for
@@ -607,9 +607,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.marker.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
@@ -716,7 +716,7 @@ def maxdisplayed(self):
"""
Sets a maximum number of points to be drawn on the graph. 0
corresponds to no limit.
-
+
The 'maxdisplayed' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -736,7 +736,7 @@ def maxdisplayed(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -757,7 +757,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -780,7 +780,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -802,7 +802,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -822,7 +822,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -845,7 +845,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -867,7 +867,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -890,7 +890,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -910,7 +910,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -933,7 +933,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -1041,7 +1041,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1210,7 +1210,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/_selected.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/_selected.py
index 9cae96337d2..603f21fa941 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/_stream.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/_stream.py
index 95ecf920b84..8e148ed1d25 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/_textfont.py
index 6fcb2d0bf37..8335f348b73 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/_unselected.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/_unselected.py
index b3ccb9ddd1b..8153e2458b5 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -53,9 +53,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -86,7 +86,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/_font.py
index 00f0545ab29..7b43d0fad31 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_colorbar.py
index 8f39b6c899b..ae5919e5862 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
marker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scattercarpet.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scattercarpet.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1557,7 +1557,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_gradient.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_gradient.py
index 49ccaa7ce46..b96b15a4449 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_gradient.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_gradient.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the final color of the gradient fill: the center color for
radial, the right for horizontal, or the bottom for vertical.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def type(self):
"""
Sets the type of gradient used to fill the markers
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['radial', 'horizontal', 'vertical', 'none']
@@ -119,7 +119,7 @@ def type(self, val):
def typesrc(self):
"""
Sets the source reference on Chart Studio Cloud for type .
-
+
The 'typesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -157,7 +157,7 @@ def __init__(
):
"""
Construct a new Gradient object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_line.py
index 90aa42b497b..3945d0e3742 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py
index 82bb0600607..a177353dca8 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py
index 91c0ad387ef..9af242ab6d0 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py
index fe2e5222c9a..587f1557833 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scattercarpet.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py
index 81072337701..a289efa717c 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_marker.py
index 75033d77677..a0f95d772fb 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_textfont.py
index fbb7ca2552c..c87f1d919bd 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_marker.py
index fd46eb24f51..c07f89cdef6 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_textfont.py
index e242b037479..fb8abd055d5 100644
--- a/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattercarpet/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scattergeo/_hoverlabel.py
index d6ad929b318..788086c69f3 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattergeo.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/_line.py b/packages/python/plotly/plotly/graph_objs/scattergeo/_line.py
index 707dff16b7a..04d03b4e27d 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -101,7 +101,7 @@ def dash(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -134,7 +134,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/_marker.py b/packages/python/plotly/plotly/graph_objs/scattergeo/_marker.py
index 429b2868f32..50cd8ae801a 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/_marker.py
@@ -46,7 +46,7 @@ def autocolorscale(self):
or `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)
@@ -71,7 +71,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -94,7 +94,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -118,7 +118,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -141,7 +141,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -164,7 +164,7 @@ def color(self):
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.
-
+
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)')
@@ -231,7 +231,7 @@ def coloraxis(self):
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
@@ -257,9 +257,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scattergeo.marker.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
@@ -502,14 +502,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -545,7 +545,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -569,9 +569,9 @@ def gradient(self):
- An instance of :class:`plotly.graph_objs.scattergeo.marker.Gradient`
- A dict of string/value properties that will be passed
to the Gradient constructor
-
+
Supported dict properties:
-
+
color
Sets the final color of the gradient fill: the
center color for radial, the right for
@@ -606,9 +606,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scattergeo.marker.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
@@ -714,7 +714,7 @@ def line(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -735,7 +735,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -758,7 +758,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -780,7 +780,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -800,7 +800,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -823,7 +823,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -845,7 +845,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -868,7 +868,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -888,7 +888,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -911,7 +911,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -1019,7 +1019,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1184,7 +1184,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/_selected.py b/packages/python/plotly/plotly/graph_objs/scattergeo/_selected.py
index a703a9d56e8..827978a17f8 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattergeo.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scattergeo.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/_stream.py b/packages/python/plotly/plotly/graph_objs/scattergeo/_stream.py
index 9b18ebe46a4..5091e794380 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattergeo/_textfont.py
index 98aec006425..d222a23c33b 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/_unselected.py b/packages/python/plotly/plotly/graph_objs/scattergeo/_unselected.py
index 38158dd3c63..2bf1c0e008a 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattergeo.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -53,9 +53,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scattergeo.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -86,7 +86,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/_font.py
index 3ba0a8793ec..1bd991be860 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_colorbar.py
index 025061e9ed0..a138a178092 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
ker.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
scattergeo.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scattergeo.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1557,7 +1557,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_gradient.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_gradient.py
index 79277589e2c..c367d74f17a 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_gradient.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_gradient.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the final color of the gradient fill: the center color for
radial, the right for horizontal, or the bottom for vertical.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def type(self):
"""
Sets the type of gradient used to fill the markers
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['radial', 'horizontal', 'vertical', 'none']
@@ -119,7 +119,7 @@ def type(self, val):
def typesrc(self):
"""
Sets the source reference on Chart Studio Cloud for type .
-
+
The 'typesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -157,7 +157,7 @@ def __init__(
):
"""
Construct a new Gradient object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_line.py
index bfe17094423..bdbf22670d6 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py
index b33765fcd89..1c43798e4f9 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py
index 3bd1705316f..7ca6376112e 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_title.py
index cec10a2405a..dc6e317e0fe 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scattergeo.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py
index f5a429d8bc1..71c6b3c4f71 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_marker.py
index 8840ad8cd90..37801459c7e 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_textfont.py
index 2e7ae08793d..ec9626f8f24 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_marker.py
index 435a4cc7f72..41322d4c592 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_textfont.py
index 33b5b87e1d8..0025b123288 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergeo/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_error_x.py b/packages/python/plotly/plotly/graph_objs/scattergl/_error_x.py
index 0c3e262ca39..4ea64751be9 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_error_x.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_error_x.py
@@ -33,7 +33,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -55,7 +55,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -76,7 +76,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -96,7 +96,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -116,7 +116,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -195,7 +195,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -215,7 +215,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -279,7 +279,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -302,7 +302,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -325,7 +325,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -345,7 +345,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -366,7 +366,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -464,7 +464,7 @@ def __init__(
):
"""
Construct a new ErrorX object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_error_y.py b/packages/python/plotly/plotly/graph_objs/scattergl/_error_y.py
index a64f90adf89..aa9cee9498c 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_error_y.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_error_y.py
@@ -32,7 +32,7 @@ def array(self):
"""
Sets the data corresponding the length of each error bar.
Values are plotted relative to the underlying data.
-
+
The 'array' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -54,7 +54,7 @@ def arrayminus(self):
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.
-
+
The 'arrayminus' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -75,7 +75,7 @@ def arrayminussrc(self):
"""
Sets the source reference on Chart Studio Cloud for arrayminus
.
-
+
The 'arrayminussrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -95,7 +95,7 @@ def arrayminussrc(self, val):
def arraysrc(self):
"""
Sets the source reference on Chart Studio Cloud for array .
-
+
The 'arraysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -115,7 +115,7 @@ def arraysrc(self, val):
def color(self):
"""
Sets the stoke color of the error bars.
-
+
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)')
@@ -176,7 +176,7 @@ def symmetric(self):
Determines whether or not the error bars have the same length
in both direction (top/bottom for vertical bars, left/right for
horizontal bars.
-
+
The 'symmetric' property must be specified as a bool
(either True, or False)
@@ -196,7 +196,7 @@ def symmetric(self, val):
def thickness(self):
"""
Sets the thickness (in px) of the error bars.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -260,7 +260,7 @@ def type(self):
`value`. If "sqrt", the bar lengths correspond to the sqaure of
the underlying data. If "data", the bar lengths are set with
data set `array`.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['percent', 'constant', 'sqrt', 'data']
@@ -283,7 +283,7 @@ def value(self):
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.
-
+
The 'value' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -306,7 +306,7 @@ def valueminus(self):
"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
-
+
The 'valueminus' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -326,7 +326,7 @@ def valueminus(self, val):
def visible(self):
"""
Determines whether or not this set of error bars is visible.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -347,7 +347,7 @@ def width(self):
"""
Sets the width (in px) of the cross-bar at both ends of the
error bars.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -442,7 +442,7 @@ def __init__(
):
"""
Construct a new ErrorY object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scattergl/_hoverlabel.py
index 33a49be5890..bc713f703b0 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattergl.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_line.py b/packages/python/plotly/plotly/graph_objs/scattergl/_line.py
index 43f17952f3f..c95ea9095ee 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -75,7 +75,7 @@ def color(self, val):
def dash(self):
"""
Sets the style of the lines.
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following enumeration values:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -98,7 +98,7 @@ def shape(self):
"""
Determines the line shape. The values correspond to step-wise
line shapes.
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'hv', 'vh', 'hvh', 'vhv']
@@ -119,7 +119,7 @@ def shape(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -154,7 +154,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_marker.py b/packages/python/plotly/plotly/graph_objs/scattergl/_marker.py
index a49fa7a0165..19860fa16ff 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_marker.py
@@ -45,7 +45,7 @@ def autocolorscale(self):
or `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)
@@ -70,7 +70,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -93,7 +93,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -117,7 +117,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -140,7 +140,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -163,7 +163,7 @@ def color(self):
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.
-
+
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)')
@@ -230,7 +230,7 @@ def coloraxis(self):
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
@@ -256,9 +256,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scattergl.marker.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
@@ -501,14 +501,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -544,7 +544,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -568,9 +568,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scattergl.marker.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
@@ -676,7 +676,7 @@ def line(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -697,7 +697,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -720,7 +720,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -742,7 +742,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -762,7 +762,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -785,7 +785,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -807,7 +807,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -830,7 +830,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -850,7 +850,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -873,7 +873,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -981,7 +981,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1142,7 +1142,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_selected.py b/packages/python/plotly/plotly/graph_objs/scattergl/_selected.py
index 5b669ca9f57..fd9fc773bf6 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattergl.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scattergl.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_stream.py b/packages/python/plotly/plotly/graph_objs/scattergl/_stream.py
index 68e342a4deb..9b9bce11c74 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattergl/_textfont.py
index 6bdae398f39..952cb190287 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/_unselected.py b/packages/python/plotly/plotly/graph_objs/scattergl/_unselected.py
index a3eb8a27c8e..d54c46d0636 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattergl.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -53,9 +53,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scattergl.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -86,7 +86,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/_font.py
index d22dc0fd11a..d3ef3bb6800 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/_colorbar.py
index 6801b49baf8..6619b61dd19 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
er.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
scattergl.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scattergl.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1556,7 +1556,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/_line.py
index faff6a8ede6..84876b0be2c 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py
index f83b49eebea..d3dadbfa90a 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py
index 1c46c40e2bf..7b056ddf271 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_title.py
index 890ee1dc4a5..271464913fd 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scattergl.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py
index 711744128e1..1bc55df0757 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattergl/selected/_marker.py
index d489bb8fecb..6be663123d6 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattergl/selected/_textfont.py
index 7f34b632481..6e1772b3816 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_marker.py
index a523932adb9..3567a2b9b39 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_textfont.py
index 09e1eda1fa7..d7a7dd47b4b 100644
--- a/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattergl/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/_hoverlabel.py
index 92ae8b342db..a3359a41e07 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/_line.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/_line.py
index c895e909be2..24de4166109 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/_marker.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/_marker.py
index 09427392508..40f1ed9c0c4 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/_marker.py
@@ -41,7 +41,7 @@ class Marker(_BaseTraceHierarchyType):
def allowoverlap(self):
"""
Flag to draw all symbols, even if they overlap.
-
+
The 'allowoverlap' property must be specified as a bool
(either True, or False)
@@ -64,7 +64,7 @@ def angle(self):
clockwise. When using the "auto" default, no rotation would be
applied in perspective views which is different from using a
zero angle.
-
+
The 'angle' property is a number and may be specified as:
- An int or float
- A tuple, list, or one-dimensional numpy array of the above
@@ -85,7 +85,7 @@ def angle(self, val):
def anglesrc(self):
"""
Sets the source reference on Chart Studio Cloud for angle .
-
+
The 'anglesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -111,7 +111,7 @@ def autocolorscale(self):
or `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)
@@ -136,7 +136,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -159,7 +159,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -183,7 +183,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -206,7 +206,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -229,7 +229,7 @@ def color(self):
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.
-
+
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)')
@@ -296,7 +296,7 @@ def coloraxis(self):
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
@@ -322,9 +322,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.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
@@ -567,14 +567,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -610,7 +610,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -630,7 +630,7 @@ def colorsrc(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -651,7 +651,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -674,7 +674,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -696,7 +696,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -716,7 +716,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -739,7 +739,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -761,7 +761,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -784,7 +784,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -804,7 +804,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -826,7 +826,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -848,7 +848,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1017,7 +1017,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/_selected.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/_selected.py
index 04e04742fa9..00179a06201 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattermapbox.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -53,7 +53,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/_stream.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/_stream.py
index a1150324165..ea8aee34d5b 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/_textfont.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/_textfont.py
index 6e2793b96c2..fc1f9f56cd1 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/_textfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Textfont object
-
+
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".
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/_unselected.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/_unselected.py
index 2d23366a117..b1e8c82b0cf 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scattermapbox.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -56,7 +56,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/_font.py
index 1a263342cde..2af351800fd 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/_colorbar.py
index f77e16d31fa..91978035da0 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
marker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scattermapbox.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scattermapbox.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1557,7 +1557,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py
index ae35db7082e..7434dd4a2e2 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py
index 4e26da9b25e..1ed6c679f47 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py
index a0e5e9dfb9c..f8de7a7fa6d 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scattermapbox.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py
index ef77497e534..5b963aa258d 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/_marker.py
index 3e08324567c..80d0d60e214 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/_marker.py
index b3357eda2a0..763ab4bc1d4 100644
--- a/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scattermapbox/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/_hoverlabel.py
index 62bb223c4b4..9784e17719b 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterpolar.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/_line.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/_line.py
index 88b564701f0..e4fd55663a2 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -103,7 +103,7 @@ def shape(self):
Determines the line shape. With "spline" the lines are drawn
using spline interpolation. The other available values
correspond to step-wise line shapes.
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'spline']
@@ -126,7 +126,7 @@ def smoothing(self):
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).
-
+
The 'smoothing' property is a number and may be specified as:
- An int or float in the interval [0, 1.3]
@@ -146,7 +146,7 @@ def smoothing(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -196,7 +196,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/_marker.py
index 10d4cae6bc0..ba9b07264bc 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/_marker.py
@@ -47,7 +47,7 @@ def autocolorscale(self):
or `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)
@@ -72,7 +72,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -95,7 +95,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -119,7 +119,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -142,7 +142,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -165,7 +165,7 @@ def color(self):
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.
-
+
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)')
@@ -232,7 +232,7 @@ def coloraxis(self):
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
@@ -258,9 +258,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.marker.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
@@ -503,14 +503,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -546,7 +546,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -570,9 +570,9 @@ def gradient(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.marker.Gradient`
- A dict of string/value properties that will be passed
to the Gradient constructor
-
+
Supported dict properties:
-
+
color
Sets the final color of the gradient fill: the
center color for radial, the right for
@@ -607,9 +607,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.marker.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
@@ -716,7 +716,7 @@ def maxdisplayed(self):
"""
Sets a maximum number of points to be drawn on the graph. 0
corresponds to no limit.
-
+
The 'maxdisplayed' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -736,7 +736,7 @@ def maxdisplayed(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -757,7 +757,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -780,7 +780,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -802,7 +802,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -822,7 +822,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -845,7 +845,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -867,7 +867,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -890,7 +890,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -910,7 +910,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -933,7 +933,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -1041,7 +1041,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1210,7 +1210,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/_selected.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/_selected.py
index 0e4baa2a6b5..342051b83ba 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/_stream.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/_stream.py
index 18af8920519..7780e5de7cb 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/_textfont.py
index 3639572efd3..f2b14368707 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/_unselected.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/_unselected.py
index 352ee62f5e9..caa5581899c 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -53,9 +53,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -86,7 +86,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/_font.py
index c401a0a008e..7d4f394ba8b 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_colorbar.py
index e738267d2d4..d32de0a8059 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
arker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scatterpolar.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.scatterpolar.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1557,7 +1557,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_gradient.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_gradient.py
index eb3d0317730..f05a3e85e80 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_gradient.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_gradient.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the final color of the gradient fill: the center color for
radial, the right for horizontal, or the bottom for vertical.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def type(self):
"""
Sets the type of gradient used to fill the markers
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['radial', 'horizontal', 'vertical', 'none']
@@ -119,7 +119,7 @@ def type(self, val):
def typesrc(self):
"""
Sets the source reference on Chart Studio Cloud for type .
-
+
The 'typesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -157,7 +157,7 @@ def __init__(
):
"""
Construct a new Gradient object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_line.py
index 18b0ca7ce0e..1fd6d42213c 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py
index 0252a81ea10..e9c9d92cd2d 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py
index e315e345e42..3a3c5bddad8 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py
index e8157585a64..5fec6f74aee 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scatterpolar.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py
index 4599b47ce5e..36e469ebf01 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_marker.py
index 696dca9500f..ba12be4e21d 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_textfont.py
index fac924583cc..3fff454a3df 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_marker.py
index f5937215d04..5308fc69941 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_textfont.py
index 68e46f261b1..eba4800f9f9 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolar/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_hoverlabel.py
index 44dea55b900..48367a41647 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterpolargl.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_line.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_line.py
index 595c2340ffb..586394068fd 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -75,7 +75,7 @@ def color(self, val):
def dash(self):
"""
Sets the style of the lines.
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following enumeration values:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -98,7 +98,7 @@ def shape(self):
"""
Determines the line shape. The values correspond to step-wise
line shapes.
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'hv', 'vh', 'hvh', 'vhv']
@@ -119,7 +119,7 @@ def shape(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -154,7 +154,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_marker.py
index 71973615fc2..fadadbc7581 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_marker.py
@@ -45,7 +45,7 @@ def autocolorscale(self):
or `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)
@@ -70,7 +70,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -93,7 +93,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -117,7 +117,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -140,7 +140,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -163,7 +163,7 @@ def color(self):
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.
-
+
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)')
@@ -230,7 +230,7 @@ def coloraxis(self):
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
@@ -256,9 +256,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scatterpolargl.marker.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
@@ -501,14 +501,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -544,7 +544,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -568,9 +568,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scatterpolargl.marker.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
@@ -676,7 +676,7 @@ def line(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -697,7 +697,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -720,7 +720,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -742,7 +742,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -762,7 +762,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -785,7 +785,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -807,7 +807,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -830,7 +830,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -850,7 +850,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -873,7 +873,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -981,7 +981,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1142,7 +1142,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_selected.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_selected.py
index cdbdb6cfc55..ad9a3c7b898 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatterpolargl.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatterpolargl.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_stream.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_stream.py
index 80e238b8b51..48df091d1ae 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_textfont.py
index 3b92d59e243..82d60b336b3 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_unselected.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_unselected.py
index be23037b352..b01345b5bdc 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -53,9 +53,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -86,7 +86,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py
index f5009466ebd..c4eb5f7318f 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_colorbar.py
index d77c490fe61..38e757894a1 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
.marker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scatterpolargl.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
scatterpolargl.marker.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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1160,14 +1160,14 @@ def titleside(self):
the location of color bar's title with respect to the color
bar. Note that the title's location used to be set by the now
deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1181,7 +1181,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1203,7 +1203,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1224,7 +1224,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1244,7 +1244,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1266,7 +1266,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1287,7 +1287,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1558,7 +1558,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_line.py
index b41804c313e..69e536bab4b 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py
index e9d7e008372..2c97e1bf14a 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py
index c7bee811cec..095a8f1ab4c 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py
index ddcc7ebdbce..fcfc893ce31 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scatterpolargl.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py
index caeae513e7f..b23cfb0ea8b 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_marker.py
index 593815a3c35..8b2afd0f534 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_textfont.py
index 971935eddb8..e7d6acfc43f 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_marker.py
index 3c9722809e0..a76cd28afca 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_textfont.py
index 0ddef418f26..3e08b8e558b 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterpolargl/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/scatterternary/_hoverlabel.py
index 7c2f65e93ac..84fa30df478 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterternary.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/_line.py b/packages/python/plotly/plotly/graph_objs/scatterternary/_line.py
index b3219c55769..34f94f5b4d2 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is an enumeration that may be specified as:
- One of the following dash styles:
['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot']
@@ -103,7 +103,7 @@ def shape(self):
Determines the line shape. With "spline" the lines are drawn
using spline interpolation. The other available values
correspond to step-wise line shapes.
-
+
The 'shape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'spline']
@@ -126,7 +126,7 @@ def smoothing(self):
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).
-
+
The 'smoothing' property is a number and may be specified as:
- An int or float in the interval [0, 1.3]
@@ -146,7 +146,7 @@ def smoothing(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -196,7 +196,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterternary/_marker.py
index bcb1f11ec76..ddde79c0ac3 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/_marker.py
@@ -47,7 +47,7 @@ def autocolorscale(self):
or `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)
@@ -72,7 +72,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -95,7 +95,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -119,7 +119,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -142,7 +142,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -165,7 +165,7 @@ def color(self):
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.
-
+
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)')
@@ -232,7 +232,7 @@ def coloraxis(self):
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
@@ -258,9 +258,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.scatterternary.marker.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
@@ -503,14 +503,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -546,7 +546,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -570,9 +570,9 @@ def gradient(self):
- An instance of :class:`plotly.graph_objs.scatterternary.marker.Gradient`
- A dict of string/value properties that will be passed
to the Gradient constructor
-
+
Supported dict properties:
-
+
color
Sets the final color of the gradient fill: the
center color for radial, the right for
@@ -607,9 +607,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.scatterternary.marker.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
@@ -716,7 +716,7 @@ def maxdisplayed(self):
"""
Sets a maximum number of points to be drawn on the graph. 0
corresponds to no limit.
-
+
The 'maxdisplayed' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -736,7 +736,7 @@ def maxdisplayed(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -757,7 +757,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -780,7 +780,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -802,7 +802,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -822,7 +822,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -845,7 +845,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -867,7 +867,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -890,7 +890,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -910,7 +910,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -933,7 +933,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -1041,7 +1041,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1210,7 +1210,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/_selected.py b/packages/python/plotly/plotly/graph_objs/scatterternary/_selected.py
index fbe11c19045..ddc92c232d5 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatterternary.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -50,9 +50,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatterternary.selected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of selected points.
@@ -82,7 +82,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/_stream.py b/packages/python/plotly/plotly/graph_objs/scatterternary/_stream.py
index c6f89a7ffb5..bb59408cd29 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterternary/_textfont.py
index afc19d04af7..bc3a2d58f7c 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the text font.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/_unselected.py b/packages/python/plotly/plotly/graph_objs/scatterternary/_unselected.py
index f3008042ffd..fe7fc77f185 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.scatterternary.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -53,9 +53,9 @@ def textfont(self):
- An instance of :class:`plotly.graph_objs.scatterternary.unselected.Textfont`
- A dict of string/value properties that will be passed
to the Textfont constructor
-
+
Supported dict properties:
-
+
color
Sets the text font color of unselected points,
applied only when a selection exists.
@@ -86,7 +86,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/_font.py
index 7e22c0eac95..c871f4d0359 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_colorbar.py
index 2884fd4f6d2..67133f9992e 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
.marker.colorbar.tickformatstopdefaults), sets the default
property values to use for elements of
scatterternary.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
scatterternary.marker.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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1160,14 +1160,14 @@ def titleside(self):
the location of color bar's title with respect to the color
bar. Note that the title's location used to be set by the now
deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1181,7 +1181,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1203,7 +1203,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1224,7 +1224,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1244,7 +1244,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1266,7 +1266,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1287,7 +1287,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1558,7 +1558,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_gradient.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_gradient.py
index bacc114fe1d..07a77d5be50 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_gradient.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_gradient.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the final color of the gradient fill: the center color for
radial, the right for horizontal, or the bottom for vertical.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def type(self):
"""
Sets the type of gradient used to fill the markers
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['radial', 'horizontal', 'vertical', 'none']
@@ -119,7 +119,7 @@ def type(self, val):
def typesrc(self):
"""
Sets the source reference on Chart Studio Cloud for type .
-
+
The 'typesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -157,7 +157,7 @@ def __init__(
):
"""
Construct a new Gradient object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_line.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_line.py
index f048acdd568..00070899909 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py
index 790b78db9dc..4d2fa14584f 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py
index b975d4d1d9d..5c875f1c4e1 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_title.py
index 7154d5b3bc9..28f0e5d7dff 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.scatterternary.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py
index 3dc589d5a02..143ae411ac8 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_marker.py
index 2b7e28cf656..ab512287a6f 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_textfont.py
index f259f3bfde4..2ca0e005ae7 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/selected/_textfont.py
@@ -16,7 +16,7 @@ class Textfont(_BaseTraceHierarchyType):
def color(self):
"""
Sets the text font color of selected points.
-
+
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)')
@@ -81,7 +81,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_marker.py
index 5afbd0770d9..6d3c1ac2a75 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_textfont.py b/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_textfont.py
index 872cff24a4c..9508ce45274 100644
--- a/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/scatterternary/unselected/_textfont.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the text font color of unselected points, applied only
when a selection exists.
-
+
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)')
@@ -83,7 +83,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, **kwargs):
"""
Construct a new Textfont object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/_diagonal.py b/packages/python/plotly/plotly/graph_objs/splom/_diagonal.py
index 5c41ae7c0fd..cb017e35783 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/_diagonal.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/_diagonal.py
@@ -17,7 +17,7 @@ def visible(self):
"""
Determines whether or not subplots on the diagonal are
displayed.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -44,7 +44,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, visible=None, **kwargs):
"""
Construct a new Diagonal object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/_dimension.py b/packages/python/plotly/plotly/graph_objs/splom/_dimension.py
index 44a9eab5e5c..a676a59fae6 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/_dimension.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/_dimension.py
@@ -28,9 +28,9 @@ def axis(self):
- An instance of :class:`plotly.graph_objs.splom.dimension.Axis`
- A dict of string/value properties that will be passed
to the Axis constructor
-
+
Supported dict properties:
-
+
matches
Determines whether or not the x & y axes
generated by this dimension match. Equivalent
@@ -58,7 +58,7 @@ def axis(self, val):
def label(self):
"""
Sets the label corresponding to this splom dimension.
-
+
The 'label' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -85,7 +85,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -113,7 +113,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -134,7 +134,7 @@ def templateitemname(self, val):
def values(self):
"""
Sets the dimension values to be plotted.
-
+
The 'values' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -154,7 +154,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -176,7 +176,7 @@ def visible(self):
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.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -245,7 +245,7 @@ def __init__(
):
"""
Construct a new Dimension object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/splom/_hoverlabel.py
index 79bbad2d16b..e84ed321d56 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.splom.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/_marker.py b/packages/python/plotly/plotly/graph_objs/splom/_marker.py
index 7f0ea782214..1408c107ea4 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/_marker.py
@@ -45,7 +45,7 @@ def autocolorscale(self):
or `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)
@@ -70,7 +70,7 @@ def cauto(self):
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.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -93,7 +93,7 @@ def cmax(self):
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.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -117,7 +117,7 @@ def cmid(self):
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`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -140,7 +140,7 @@ def cmin(self):
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.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -163,7 +163,7 @@ def color(self):
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.
-
+
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)')
@@ -230,7 +230,7 @@ def coloraxis(self):
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
@@ -256,9 +256,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.splom.marker.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
@@ -501,14 +501,14 @@ def colorscale(self):
may be a palette name string of the following list: Greys,YlGnB
u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland
,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -544,7 +544,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -568,9 +568,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.splom.marker.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
@@ -676,7 +676,7 @@ def line(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' 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
@@ -697,7 +697,7 @@ def opacity(self, val):
def opacitysrc(self):
"""
Sets the source reference on Chart Studio Cloud for opacity .
-
+
The 'opacitysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -720,7 +720,7 @@ def reversescale(self):
`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.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -742,7 +742,7 @@ def showscale(self):
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.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -762,7 +762,7 @@ def showscale(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' 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
@@ -785,7 +785,7 @@ def sizemin(self):
Has an effect only if `marker.size` is set to a numerical
array. Sets the minimum size (in px) of the rendered marker
points.
-
+
The 'sizemin' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -807,7 +807,7 @@ def sizemode(self):
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.
-
+
The 'sizemode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['diameter', 'area']
@@ -830,7 +830,7 @@ def sizeref(self):
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`.
-
+
The 'sizeref' property is a number and may be specified as:
- An int or float
@@ -850,7 +850,7 @@ def sizeref(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -873,7 +873,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -981,7 +981,7 @@ def symbol(self, val):
def symbolsrc(self):
"""
Sets the source reference on Chart Studio Cloud for symbol .
-
+
The 'symbolsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1142,7 +1142,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/_selected.py b/packages/python/plotly/plotly/graph_objs/splom/_selected.py
index 7e0f9d7584f..30b90fb55a3 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.splom.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -53,7 +53,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/_stream.py b/packages/python/plotly/plotly/graph_objs/splom/_stream.py
index ac84a884b05..34340a280f7 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/_unselected.py b/packages/python/plotly/plotly/graph_objs/splom/_unselected.py
index 41c79cf420c..733b5875486 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.splom.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -56,7 +56,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/dimension/_axis.py b/packages/python/plotly/plotly/graph_objs/splom/dimension/_axis.py
index 6c8d8b4463b..3fe4b69c327 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/dimension/_axis.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/dimension/_axis.py
@@ -18,7 +18,7 @@ def matches(self):
Determines whether or not the x & y axes generated by this
dimension match. Equivalent to setting the `matches` axis
attribute in the layout with the correct axis id.
-
+
The 'matches' property must be specified as a bool
(either True, or False)
@@ -40,7 +40,7 @@ def type(self):
Sets the axis type for this dimension's generated x and y axes.
Note that the axis `type` values set in layout take precedence
over this attribute.
-
+
The 'type' property is an enumeration that may be specified as:
- One of the following enumeration values:
['linear', 'log', 'date', 'category']
@@ -74,7 +74,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, matches=None, type=None, **kwargs):
"""
Construct a new Axis object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/_font.py
index bf25c774e97..757d67c8e32 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/splom/marker/_colorbar.py
index c77dd0edb1a..7017f583a4d 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.splom.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.splom.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
olorbar.tickformatstopdefaults), sets the default property
values to use for elements of
splom.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.splom.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/_line.py b/packages/python/plotly/plotly/graph_objs/splom/marker/_line.py
index 4ba00284a75..3ddeb6c9c8f 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/marker/_line.py
@@ -35,7 +35,7 @@ def autocolorscale(self):
`colorscale` is unspecified or `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)
@@ -60,7 +60,7 @@ def cauto(self):
effect only if in `marker.line.color`is set to a numerical
array. Defaults to `false` when `marker.line.cmin` and
`marker.line.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -83,7 +83,7 @@ def cmax(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
set to a numerical array. Value should have the same units as
in `marker.line.color`. Has no effect when `marker.line.cauto`
is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -131,7 +131,7 @@ def cmin(self):
in `marker.line.color`is set to a numerical array. Value should
have the same units as in `marker.line.color` and if set,
`marker.line.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -154,7 +154,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -221,7 +221,7 @@ def coloraxis(self):
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
@@ -254,14 +254,14 @@ def colorscale(self):
following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl
ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi
ridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -297,7 +297,7 @@ def colorscale(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -321,7 +321,7 @@ def reversescale(self):
`marker.line.cmin` will correspond to the last color in the
array and `marker.line.cmax` will correspond to the first
color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -341,7 +341,7 @@ def reversescale(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
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
@@ -362,7 +362,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -481,7 +481,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickfont.py
index 43bf554e787..2d2bfa07a4e 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py
index c80b2cb81f4..a2c35c4efea 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_title.py
index 633fef0422c..99973165d64 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.splom.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/_font.py
index 2e82c4535a1..7c9fc1a054b 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/splom/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/splom/selected/_marker.py
index 29631a5ce16..dca4aeb1cc6 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/splom/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/splom/unselected/_marker.py
index 4a084bb4be0..dde087e43e6 100644
--- a/packages/python/plotly/plotly/graph_objs/splom/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/splom/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/_colorbar.py b/packages/python/plotly/plotly/graph_objs/streamtube/_colorbar.py
index 346fb39eb29..d2ba5ed44fb 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.streamtube.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -827,13 +827,13 @@ def tickformatstopdefaults(self):
When used in a template (as layout.template.data.streamtube.col
orbar.tickformatstopdefaults), sets the default property values
to use for elements of streamtube.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -852,7 +852,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -878,7 +878,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -899,7 +899,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -922,7 +922,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -943,7 +943,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -966,7 +966,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -986,7 +986,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1007,7 +1007,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1027,7 +1027,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1047,7 +1047,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1071,9 +1071,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.streamtube.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1108,17 +1108,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.colorbar.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
@@ -1140,7 +1140,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1157,14 +1157,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1178,7 +1178,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1200,7 +1200,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1221,7 +1221,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1241,7 +1241,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1263,7 +1263,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1284,7 +1284,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1553,7 +1553,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/streamtube/_hoverlabel.py
index 3e8fddc29db..eb9dba3ec5a 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.streamtube.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/_lighting.py b/packages/python/plotly/plotly/graph_objs/streamtube/_lighting.py
index dce624cd8fa..a6c89dc68c3 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/_lighting.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/_lighting.py
@@ -25,7 +25,7 @@ def ambient(self):
"""
Ambient light increases overall color visibility but can wash
out the image.
-
+
The 'ambient' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -46,7 +46,7 @@ def diffuse(self):
"""
Represents the extent that incident rays are reflected in a
range of angles.
-
+
The 'diffuse' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -67,7 +67,7 @@ def facenormalsepsilon(self):
"""
Epsilon for face normals calculation avoids math issues arising
from degenerate geometry.
-
+
The 'facenormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -89,7 +89,7 @@ def fresnel(self):
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.
-
+
The 'fresnel' property is a number and may be specified as:
- An int or float in the interval [0, 5]
@@ -110,7 +110,7 @@ def roughness(self):
"""
Alters specular reflection; the rougher the surface, the wider
and less contrasty the shine.
-
+
The 'roughness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -131,7 +131,7 @@ def specular(self):
"""
Represents the level that incident rays are reflected in a
single direction, causing shine.
-
+
The 'specular' property is a number and may be specified as:
- An int or float in the interval [0, 2]
@@ -152,7 +152,7 @@ def vertexnormalsepsilon(self):
"""
Epsilon for vertex normals calculation avoids math issues
arising from degenerate geometry.
-
+
The 'vertexnormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -210,7 +210,7 @@ def __init__(
):
"""
Construct a new Lighting object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/_lightposition.py b/packages/python/plotly/plotly/graph_objs/streamtube/_lightposition.py
index 9b5f87a7ec5..d31602e501e 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/_lightposition.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/_lightposition.py
@@ -16,7 +16,7 @@ class Lightposition(_BaseTraceHierarchyType):
def x(self):
"""
Numeric vector, representing the X coordinate for each vertex.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -36,7 +36,7 @@ def x(self, val):
def y(self):
"""
Numeric vector, representing the Y coordinate for each vertex.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -56,7 +56,7 @@ def y(self, val):
def z(self):
"""
Numeric vector, representing the Z coordinate for each vertex.
-
+
The 'z' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Lightposition object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/_starts.py b/packages/python/plotly/plotly/graph_objs/streamtube/_starts.py
index 0e0d53825da..8bd3fe617ab 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/_starts.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/_starts.py
@@ -17,7 +17,7 @@ def x(self):
"""
Sets the x components of the starting position of the
streamtubes
-
+
The 'x' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -37,7 +37,7 @@ def x(self, val):
def xsrc(self):
"""
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
@@ -58,7 +58,7 @@ def y(self):
"""
Sets the y components of the starting position of the
streamtubes
-
+
The 'y' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -78,7 +78,7 @@ def y(self, val):
def ysrc(self):
"""
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
@@ -99,7 +99,7 @@ def z(self):
"""
Sets the z components of the starting position of the
streamtubes
-
+
The 'z' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -119,7 +119,7 @@ def z(self, val):
def zsrc(self):
"""
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
@@ -171,7 +171,7 @@ def __init__(
):
"""
Construct a new Starts object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/_stream.py b/packages/python/plotly/plotly/graph_objs/streamtube/_stream.py
index 904ea62d2d1..e8f3905d076 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickfont.py
index 5919d69104d..36d0c998843 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py
index b62b85cfd45..7b800c2a202 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_title.py
index c9f7ad38edf..6c06a24693c 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.streamtube.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/_font.py
index 7595948112c..abf352cad53 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/_font.py
index 978092c7e47..361cf163fb3 100644
--- a/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/streamtube/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_domain.py b/packages/python/plotly/plotly/graph_objs/sunburst/_domain.py
index 748f8ad957d..4d94c62bc2c 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this sunburst trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this sunburst trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this sunburst trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this sunburst trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this sunburst trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this sunburst trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/sunburst/_hoverlabel.py
index 5d3e3b22f55..ed2d53901c1 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.sunburst.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_insidetextfont.py b/packages/python/plotly/plotly/graph_objs/sunburst/_insidetextfont.py
index 71fb3abd5f3..ac2526a9a85 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_insidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_insidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Insidetextfont object
-
+
Sets the font used for `textinfo` lying inside the sector.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_leaf.py b/packages/python/plotly/plotly/graph_objs/sunburst/_leaf.py
index d8346ca6f0e..2e2c9b2ae59 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_leaf.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_leaf.py
@@ -17,7 +17,7 @@ def opacity(self):
"""
Sets the opacity of the leaves. With colorscale it is defaulted
to 1; otherwise it is defaulted to 0.7
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -44,7 +44,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, opacity=None, **kwargs):
"""
Construct a new Leaf object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_marker.py b/packages/python/plotly/plotly/graph_objs/sunburst/_marker.py
index d93e9785786..6956d8c33ed 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_marker.py
@@ -36,7 +36,7 @@ def autocolorscale(self):
`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)
@@ -60,7 +60,7 @@ def cauto(self):
`marker.cmin` and `marker.cmax` Has an effect only if colorsis
set to a numerical array. Defaults to `false` when
`marker.cmin` and `marker.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -82,7 +82,7 @@ def cmax(self):
Sets the upper bound of the color domain. Has an effect only if
colorsis set to a numerical array. Value should have the same
units as colors and if set, `marker.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -106,7 +106,7 @@ def cmid(self):
effect only if colorsis set to a numerical array. Value should
have the same units as colors. Has no effect when
`marker.cauto` is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -128,7 +128,7 @@ def cmin(self):
Sets the lower bound of the color domain. Has an effect only if
colorsis set to a numerical array. Value should have the same
units as colors and if set, `marker.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -153,7 +153,7 @@ def coloraxis(self):
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
@@ -179,9 +179,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.sunburst.marker.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
@@ -415,7 +415,7 @@ def colors(self):
"""
Sets the color of each sector of this trace. If not specified,
the default trace color set is used to pick the sector colors.
-
+
The 'colors' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -445,14 +445,14 @@ def colorscale(self):
name string of the following list: Greys,YlGnBu,Greens,YlOrRd,B
luered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbod
y,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -488,7 +488,7 @@ def colorscale(self, val):
def colorssrc(self):
"""
Sets the source reference on Chart Studio Cloud for colors .
-
+
The 'colorssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -512,9 +512,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.sunburst.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the line enclosing each
sector. Defaults to the `paper_bgcolor` value.
@@ -547,7 +547,7 @@ def reversescale(self):
colorsis set to a numerical array. If true, `marker.cmin` will
correspond to the last color in the array and `marker.cmax`
will correspond to the first color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -568,7 +568,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace. Has an effect only if colorsis set to a numerical array.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -685,7 +685,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_outsidetextfont.py b/packages/python/plotly/plotly/graph_objs/sunburst/_outsidetextfont.py
index 5dab1d48141..7ca35066257 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_outsidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_outsidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Outsidetextfont object
-
+
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
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_stream.py b/packages/python/plotly/plotly/graph_objs/sunburst/_stream.py
index 22a0d13f3fd..71152a8e1a0 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/_textfont.py b/packages/python/plotly/plotly/graph_objs/sunburst/_textfont.py
index 235e78c7bab..f0b614b0a8d 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used for `textinfo`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/_font.py
index 11980821c6f..470338f5a0a 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/_colorbar.py
index d02d813afa8..f2a2385c6c5 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
r.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
sunburst.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.sunburst.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/_line.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/_line.py
index 880344c6e3d..942e2e0b30e 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/_line.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the color of the line enclosing each sector. Defaults to
the `paper_bgcolor` value.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the line enclosing each sector.
-
+
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
@@ -118,7 +118,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -156,7 +156,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py
index 723c2318425..b2f31f88f75 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py
index 671500917ca..4d28be6c936 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_title.py
index 26824c1af50..a51cf0bfbb5 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.sunburst.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py
index 7938bfb6b3f..9063aaff5d4 100644
--- a/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/surface/_colorbar.py b/packages/python/plotly/plotly/graph_objs/surface/_colorbar.py
index 2bb8e6d7d2b..12a9b40ba13 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.surface.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.surface.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
layout.template.data.surface.colorbar.tickformatstopdefaults),
sets the default property values to use for elements of
surface.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.surface.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.surface.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1109,17 +1109,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.surface.colorbar.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
@@ -1141,7 +1141,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1158,14 +1158,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1179,7 +1179,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1201,7 +1201,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1222,7 +1222,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1242,7 +1242,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1264,7 +1264,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1285,7 +1285,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1554,7 +1554,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/_contours.py b/packages/python/plotly/plotly/graph_objs/surface/_contours.py
index a47b54f164a..63da796ac76 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/_contours.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/_contours.py
@@ -20,9 +20,9 @@ def x(self):
- An instance of :class:`plotly.graph_objs.surface.contours.X`
- A dict of string/value properties that will be passed
to the X constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the contour lines.
end
@@ -77,9 +77,9 @@ def y(self):
- An instance of :class:`plotly.graph_objs.surface.contours.Y`
- A dict of string/value properties that will be passed
to the Y constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the contour lines.
end
@@ -134,9 +134,9 @@ def z(self):
- An instance of :class:`plotly.graph_objs.surface.contours.Z`
- A dict of string/value properties that will be passed
to the Z constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the contour lines.
end
@@ -200,7 +200,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Contours object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/surface/_hoverlabel.py
index fad7dc24ec9..a4f1b91b16c 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.surface.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/_lighting.py b/packages/python/plotly/plotly/graph_objs/surface/_lighting.py
index 6e7107938c1..b6b528a9e47 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/_lighting.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/_lighting.py
@@ -17,7 +17,7 @@ def ambient(self):
"""
Ambient light increases overall color visibility but can wash
out the image.
-
+
The 'ambient' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -38,7 +38,7 @@ def diffuse(self):
"""
Represents the extent that incident rays are reflected in a
range of angles.
-
+
The 'diffuse' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -60,7 +60,7 @@ def fresnel(self):
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.
-
+
The 'fresnel' property is a number and may be specified as:
- An int or float in the interval [0, 5]
@@ -81,7 +81,7 @@ def roughness(self):
"""
Alters specular reflection; the rougher the surface, the wider
and less contrasty the shine.
-
+
The 'roughness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -102,7 +102,7 @@ def specular(self):
"""
Represents the level that incident rays are reflected in a
single direction, causing shine.
-
+
The 'specular' property is a number and may be specified as:
- An int or float in the interval [0, 2]
@@ -152,7 +152,7 @@ def __init__(
):
"""
Construct a new Lighting object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/_lightposition.py b/packages/python/plotly/plotly/graph_objs/surface/_lightposition.py
index 99c758055cd..f4a2537b293 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/_lightposition.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/_lightposition.py
@@ -16,7 +16,7 @@ class Lightposition(_BaseTraceHierarchyType):
def x(self):
"""
Numeric vector, representing the X coordinate for each vertex.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -36,7 +36,7 @@ def x(self, val):
def y(self):
"""
Numeric vector, representing the Y coordinate for each vertex.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -56,7 +56,7 @@ def y(self, val):
def z(self):
"""
Numeric vector, representing the Z coordinate for each vertex.
-
+
The 'z' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Lightposition object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/_stream.py b/packages/python/plotly/plotly/graph_objs/surface/_stream.py
index 124b35d9857..4a19df6d146 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickfont.py
index f416b42be47..076677a2ccd 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickformatstop.py
index 21dce94ff35..b4c0b213f1f 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/surface/colorbar/_title.py
index 01fa28bd548..87a46ac14c8 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.surface.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/_font.py
index 7d0f3f635e9..e051e57d887 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/_x.py b/packages/python/plotly/plotly/graph_objs/surface/contours/_x.py
index 04b2858bb0d..0a982e97d6f 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/contours/_x.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/contours/_x.py
@@ -28,7 +28,7 @@ class X(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the contour lines.
-
+
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)')
@@ -88,7 +88,7 @@ def end(self):
"""
Sets the end contour level value. Must be more than
`contours.start`
-
+
The 'end' property is a number and may be specified as:
- An int or float
@@ -109,7 +109,7 @@ def highlight(self):
"""
Determines whether or not contour lines about the x dimension
are highlighted on hover.
-
+
The 'highlight' property must be specified as a bool
(either True, or False)
@@ -129,7 +129,7 @@ def highlight(self, val):
def highlightcolor(self):
"""
Sets the color of the highlighted contour lines.
-
+
The 'highlightcolor' 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)')
@@ -188,7 +188,7 @@ def highlightcolor(self, val):
def highlightwidth(self):
"""
Sets the width of the highlighted contour lines.
-
+
The 'highlightwidth' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -212,9 +212,9 @@ def project(self):
- An instance of :class:`plotly.graph_objs.surface.contours.x.Project`
- A dict of string/value properties that will be passed
to the Project constructor
-
+
Supported dict properties:
-
+
x
Determines whether or not these contour lines
are projected on the x plane. If `highlight` is
@@ -251,7 +251,7 @@ def show(self):
"""
Determines whether or not contour lines about the x dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -271,7 +271,7 @@ def show(self, val):
def size(self):
"""
Sets the step between each contour level. Must be positive.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -292,7 +292,7 @@ def start(self):
"""
Sets the starting contour level value. Must be less than
`contours.end`
-
+
The 'start' property is a number and may be specified as:
- An int or float
@@ -313,7 +313,7 @@ def usecolormap(self):
"""
An alternate to "color". Determines whether or not the contour
lines are colored using the trace "colorscale".
-
+
The 'usecolormap' property must be specified as a bool
(either True, or False)
@@ -333,7 +333,7 @@ def usecolormap(self, val):
def width(self):
"""
Sets the width of the contour lines.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -401,7 +401,7 @@ def __init__(
):
"""
Construct a new X object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/_y.py b/packages/python/plotly/plotly/graph_objs/surface/contours/_y.py
index edf99787d24..40777c1c20e 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/contours/_y.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/contours/_y.py
@@ -28,7 +28,7 @@ class Y(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the contour lines.
-
+
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)')
@@ -88,7 +88,7 @@ def end(self):
"""
Sets the end contour level value. Must be more than
`contours.start`
-
+
The 'end' property is a number and may be specified as:
- An int or float
@@ -109,7 +109,7 @@ def highlight(self):
"""
Determines whether or not contour lines about the y dimension
are highlighted on hover.
-
+
The 'highlight' property must be specified as a bool
(either True, or False)
@@ -129,7 +129,7 @@ def highlight(self, val):
def highlightcolor(self):
"""
Sets the color of the highlighted contour lines.
-
+
The 'highlightcolor' 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)')
@@ -188,7 +188,7 @@ def highlightcolor(self, val):
def highlightwidth(self):
"""
Sets the width of the highlighted contour lines.
-
+
The 'highlightwidth' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -212,9 +212,9 @@ def project(self):
- An instance of :class:`plotly.graph_objs.surface.contours.y.Project`
- A dict of string/value properties that will be passed
to the Project constructor
-
+
Supported dict properties:
-
+
x
Determines whether or not these contour lines
are projected on the x plane. If `highlight` is
@@ -251,7 +251,7 @@ def show(self):
"""
Determines whether or not contour lines about the y dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -271,7 +271,7 @@ def show(self, val):
def size(self):
"""
Sets the step between each contour level. Must be positive.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -292,7 +292,7 @@ def start(self):
"""
Sets the starting contour level value. Must be less than
`contours.end`
-
+
The 'start' property is a number and may be specified as:
- An int or float
@@ -313,7 +313,7 @@ def usecolormap(self):
"""
An alternate to "color". Determines whether or not the contour
lines are colored using the trace "colorscale".
-
+
The 'usecolormap' property must be specified as a bool
(either True, or False)
@@ -333,7 +333,7 @@ def usecolormap(self, val):
def width(self):
"""
Sets the width of the contour lines.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -401,7 +401,7 @@ def __init__(
):
"""
Construct a new Y object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/_z.py b/packages/python/plotly/plotly/graph_objs/surface/contours/_z.py
index f65382b9cc6..2cc787916b8 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/contours/_z.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/contours/_z.py
@@ -28,7 +28,7 @@ class Z(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the contour lines.
-
+
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)')
@@ -88,7 +88,7 @@ def end(self):
"""
Sets the end contour level value. Must be more than
`contours.start`
-
+
The 'end' property is a number and may be specified as:
- An int or float
@@ -109,7 +109,7 @@ def highlight(self):
"""
Determines whether or not contour lines about the z dimension
are highlighted on hover.
-
+
The 'highlight' property must be specified as a bool
(either True, or False)
@@ -129,7 +129,7 @@ def highlight(self, val):
def highlightcolor(self):
"""
Sets the color of the highlighted contour lines.
-
+
The 'highlightcolor' 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)')
@@ -188,7 +188,7 @@ def highlightcolor(self, val):
def highlightwidth(self):
"""
Sets the width of the highlighted contour lines.
-
+
The 'highlightwidth' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -212,9 +212,9 @@ def project(self):
- An instance of :class:`plotly.graph_objs.surface.contours.z.Project`
- A dict of string/value properties that will be passed
to the Project constructor
-
+
Supported dict properties:
-
+
x
Determines whether or not these contour lines
are projected on the x plane. If `highlight` is
@@ -251,7 +251,7 @@ def show(self):
"""
Determines whether or not contour lines about the z dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -271,7 +271,7 @@ def show(self, val):
def size(self):
"""
Sets the step between each contour level. Must be positive.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -292,7 +292,7 @@ def start(self):
"""
Sets the starting contour level value. Must be less than
`contours.end`
-
+
The 'start' property is a number and may be specified as:
- An int or float
@@ -313,7 +313,7 @@ def usecolormap(self):
"""
An alternate to "color". Determines whether or not the contour
lines are colored using the trace "colorscale".
-
+
The 'usecolormap' property must be specified as a bool
(either True, or False)
@@ -333,7 +333,7 @@ def usecolormap(self, val):
def width(self):
"""
Sets the width of the contour lines.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -401,7 +401,7 @@ def __init__(
):
"""
Construct a new Z object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/x/_project.py b/packages/python/plotly/plotly/graph_objs/surface/contours/x/_project.py
index 855ddc62e92..7bd12f07cdc 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/contours/x/_project.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/contours/x/_project.py
@@ -19,7 +19,7 @@ def x(self):
the x plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'x' property must be specified as a bool
(either True, or False)
@@ -42,7 +42,7 @@ def y(self):
the y plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'y' property must be specified as a bool
(either True, or False)
@@ -65,7 +65,7 @@ def z(self):
the z plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'z' property must be specified as a bool
(either True, or False)
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Project object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/y/_project.py b/packages/python/plotly/plotly/graph_objs/surface/contours/y/_project.py
index 9f0c8c5189a..c6b7afd3c81 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/contours/y/_project.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/contours/y/_project.py
@@ -19,7 +19,7 @@ def x(self):
the x plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'x' property must be specified as a bool
(either True, or False)
@@ -42,7 +42,7 @@ def y(self):
the y plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'y' property must be specified as a bool
(either True, or False)
@@ -65,7 +65,7 @@ def z(self):
the z plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'z' property must be specified as a bool
(either True, or False)
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Project object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/contours/z/_project.py b/packages/python/plotly/plotly/graph_objs/surface/contours/z/_project.py
index b99a929db44..2a66a4a5a33 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/contours/z/_project.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/contours/z/_project.py
@@ -19,7 +19,7 @@ def x(self):
the x plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'x' property must be specified as a bool
(either True, or False)
@@ -42,7 +42,7 @@ def y(self):
the y plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'y' property must be specified as a bool
(either True, or False)
@@ -65,7 +65,7 @@ def z(self):
the z plane. If `highlight` is set to True (the default), the
projected lines are shown on hover. If `show` is set to True,
the projected lines are shown in permanence.
-
+
The 'z' property must be specified as a bool
(either True, or False)
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Project object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/_font.py
index 4dd536a5096..6325c03b2f7 100644
--- a/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/surface/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/table/_cells.py b/packages/python/plotly/plotly/graph_objs/table/_cells.py
index a78f3711671..12b6f87dc6a 100644
--- a/packages/python/plotly/plotly/graph_objs/table/_cells.py
+++ b/packages/python/plotly/plotly/graph_objs/table/_cells.py
@@ -34,7 +34,7 @@ def align(self):
an effect only if `text` spans two or more lines (i.e. `text`
contains one or more
HTML tags) or if an explicit width is
set to override the text width.
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -56,7 +56,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -80,9 +80,9 @@ def fill(self):
- An instance of :class:`plotly.graph_objs.table.cells.Fill`
- A dict of string/value properties that will be passed
to the Fill constructor
-
+
Supported dict properties:
-
+
color
Sets the cell fill color. It accepts either a
specific color or an array of colors or a 2D
@@ -111,11 +111,11 @@ def font(self):
- An instance of :class:`plotly.graph_objs.table.cells.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 .
@@ -140,7 +140,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -164,7 +164,7 @@ def format(self):
language which is similar to those of Python. See
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'format' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -184,7 +184,7 @@ def format(self, val):
def formatsrc(self):
"""
Sets the source reference on Chart Studio Cloud for format .
-
+
The 'formatsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -204,7 +204,7 @@ def formatsrc(self, val):
def height(self):
"""
The height of cells.
-
+
The 'height' property is a number and may be specified as:
- An int or float
@@ -228,16 +228,16 @@ def line(self):
- An instance of :class:`plotly.graph_objs.table.cells.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
-
+
colorsrc
Sets the source reference on Chart Studio Cloud
for color .
width
-
+
widthsrc
Sets the source reference on Chart Studio Cloud
for width .
@@ -258,7 +258,7 @@ def line(self, val):
def prefix(self):
"""
Prefix for cell values.
-
+
The 'prefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -280,7 +280,7 @@ def prefix(self, val):
def prefixsrc(self):
"""
Sets the source reference on Chart Studio Cloud for prefix .
-
+
The 'prefixsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -300,7 +300,7 @@ def prefixsrc(self, val):
def suffix(self):
"""
Suffix for cell values.
-
+
The 'suffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -322,7 +322,7 @@ def suffix(self, val):
def suffixsrc(self):
"""
Sets the source reference on Chart Studio Cloud for suffix .
-
+
The 'suffixsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -345,7 +345,7 @@ def values(self):
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.
-
+
The 'values' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -365,7 +365,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -454,7 +454,7 @@ def __init__(
):
"""
Construct a new Cells object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/_domain.py b/packages/python/plotly/plotly/graph_objs/table/_domain.py
index 112c77fa468..364573e666d 100644
--- a/packages/python/plotly/plotly/graph_objs/table/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/table/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this table trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this table trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this table trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this table trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this table trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this table trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/_header.py b/packages/python/plotly/plotly/graph_objs/table/_header.py
index 8c00fc54c57..019aa29718b 100644
--- a/packages/python/plotly/plotly/graph_objs/table/_header.py
+++ b/packages/python/plotly/plotly/graph_objs/table/_header.py
@@ -34,7 +34,7 @@ def align(self):
an effect only if `text` spans two or more lines (i.e. `text`
contains one or more
HTML tags) or if an explicit width is
set to override the text width.
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -56,7 +56,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -80,9 +80,9 @@ def fill(self):
- An instance of :class:`plotly.graph_objs.table.header.Fill`
- A dict of string/value properties that will be passed
to the Fill constructor
-
+
Supported dict properties:
-
+
color
Sets the cell fill color. It accepts either a
specific color or an array of colors or a 2D
@@ -111,11 +111,11 @@ def font(self):
- An instance of :class:`plotly.graph_objs.table.header.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 .
@@ -140,7 +140,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -164,7 +164,7 @@ def format(self):
language which is similar to those of Python. See
https://github.com/d3/d3-3.x-api-
reference/blob/master/Formatting.md#d3_format
-
+
The 'format' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -184,7 +184,7 @@ def format(self, val):
def formatsrc(self):
"""
Sets the source reference on Chart Studio Cloud for format .
-
+
The 'formatsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -204,7 +204,7 @@ def formatsrc(self, val):
def height(self):
"""
The height of cells.
-
+
The 'height' property is a number and may be specified as:
- An int or float
@@ -228,16 +228,16 @@ def line(self):
- An instance of :class:`plotly.graph_objs.table.header.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
-
+
colorsrc
Sets the source reference on Chart Studio Cloud
for color .
width
-
+
widthsrc
Sets the source reference on Chart Studio Cloud
for width .
@@ -258,7 +258,7 @@ def line(self, val):
def prefix(self):
"""
Prefix for cell values.
-
+
The 'prefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -280,7 +280,7 @@ def prefix(self, val):
def prefixsrc(self):
"""
Sets the source reference on Chart Studio Cloud for prefix .
-
+
The 'prefixsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -300,7 +300,7 @@ def prefixsrc(self, val):
def suffix(self):
"""
Suffix for cell values.
-
+
The 'suffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -322,7 +322,7 @@ def suffix(self, val):
def suffixsrc(self):
"""
Sets the source reference on Chart Studio Cloud for suffix .
-
+
The 'suffixsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -345,7 +345,7 @@ def values(self):
`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.
-
+
The 'values' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -365,7 +365,7 @@ def values(self, val):
def valuessrc(self):
"""
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
@@ -454,7 +454,7 @@ def __init__(
):
"""
Construct a new Header object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/table/_hoverlabel.py
index 353d3782e54..1cc35f14bcc 100644
--- a/packages/python/plotly/plotly/graph_objs/table/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/table/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.table.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/_stream.py b/packages/python/plotly/plotly/graph_objs/table/_stream.py
index a4aa99a1feb..42b71d58797 100644
--- a/packages/python/plotly/plotly/graph_objs/table/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/table/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/cells/_fill.py b/packages/python/plotly/plotly/graph_objs/table/cells/_fill.py
index 7b12bb07015..f62a307b472 100644
--- a/packages/python/plotly/plotly/graph_objs/table/cells/_fill.py
+++ b/packages/python/plotly/plotly/graph_objs/table/cells/_fill.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the cell fill color. It accepts either a specific color or
an array of colors or a 2D array of colors.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, colorsrc=None, **kwargs):
"""
Construct a new Fill object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/cells/_font.py b/packages/python/plotly/plotly/graph_objs/table/cells/_font.py
index 7de7c742888..0003379fc1f 100644
--- a/packages/python/plotly/plotly/graph_objs/table/cells/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/table/cells/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/cells/_line.py b/packages/python/plotly/plotly/graph_objs/table/cells/_line.py
index c8995135e20..3511defe9f5 100644
--- a/packages/python/plotly/plotly/graph_objs/table/cells/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/table/cells/_line.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -113,7 +113,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -149,7 +149,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/header/_fill.py b/packages/python/plotly/plotly/graph_objs/table/header/_fill.py
index 054c93c3ee9..0a93c9db620 100644
--- a/packages/python/plotly/plotly/graph_objs/table/header/_fill.py
+++ b/packages/python/plotly/plotly/graph_objs/table/header/_fill.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the cell fill color. It accepts either a specific color or
an array of colors or a 2D array of colors.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -107,7 +107,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, colorsrc=None, **kwargs):
"""
Construct a new Fill object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/header/_font.py b/packages/python/plotly/plotly/graph_objs/table/header/_font.py
index 1ec7e4a21ca..21499b82819 100644
--- a/packages/python/plotly/plotly/graph_objs/table/header/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/table/header/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/header/_line.py b/packages/python/plotly/plotly/graph_objs/table/header/_line.py
index 5d51db65ee7..7cdd5c12e4e 100644
--- a/packages/python/plotly/plotly/graph_objs/table/header/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/table/header/_line.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -113,7 +113,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -149,7 +149,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/table/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/table/hoverlabel/_font.py
index 654d550e943..d1f4fb839bb 100644
--- a/packages/python/plotly/plotly/graph_objs/table/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/table/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_domain.py b/packages/python/plotly/plotly/graph_objs/treemap/_domain.py
index 7a49e2974d5..74ae46181e1 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_domain.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_domain.py
@@ -17,7 +17,7 @@ def column(self):
"""
If there is a layout grid, use the domain for this column in
the grid for this treemap trace .
-
+
The 'column' 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]
@@ -39,7 +39,7 @@ def row(self):
"""
If there is a layout grid, use the domain for this row in the
grid for this treemap trace .
-
+
The 'row' 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]
@@ -59,20 +59,20 @@ def row(self, val):
@property
def x(self):
"""
- Sets the horizontal domain of this treemap trace (in plot
- fraction).
-
- The 'x' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'x[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'x[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the horizontal domain of this treemap trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'x' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'x[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'x[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["x"]
@@ -85,20 +85,20 @@ def x(self, val):
@property
def y(self):
"""
- Sets the vertical domain of this treemap trace (in plot
- fraction).
-
- The 'y' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'y[0]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
- (1) The 'y[1]' property is a number and may be specified as:
- - An int or float in the interval [0, 1]
+ Sets the vertical domain of this treemap trace (in plot
+ fraction).
- Returns
- -------
- list
+ The 'y' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'y[0]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+ (1) The 'y[1]' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ list
"""
return self["y"]
@@ -128,7 +128,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs):
"""
Construct a new Domain object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/treemap/_hoverlabel.py
index 3eb6ae18b80..0d0c169f14b 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.treemap.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_insidetextfont.py b/packages/python/plotly/plotly/graph_objs/treemap/_insidetextfont.py
index 3c9848f02d0..c5d6ab6e3cb 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_insidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_insidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Insidetextfont object
-
+
Sets the font used for `textinfo` lying inside the sector.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_marker.py b/packages/python/plotly/plotly/graph_objs/treemap/_marker.py
index 2ce5ce1e583..fa27674fbb2 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_marker.py
@@ -38,7 +38,7 @@ def autocolorscale(self):
`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)
@@ -62,7 +62,7 @@ def cauto(self):
`marker.cmin` and `marker.cmax` Has an effect only if colorsis
set to a numerical array. Defaults to `false` when
`marker.cmin` and `marker.cmax` are set by the user.
-
+
The 'cauto' property must be specified as a bool
(either True, or False)
@@ -84,7 +84,7 @@ def cmax(self):
Sets the upper bound of the color domain. Has an effect only if
colorsis set to a numerical array. Value should have the same
units as colors and if set, `marker.cmin` must be set as well.
-
+
The 'cmax' property is a number and may be specified as:
- An int or float
@@ -108,7 +108,7 @@ def cmid(self):
effect only if colorsis set to a numerical array. Value should
have the same units as colors. Has no effect when
`marker.cauto` is `false`.
-
+
The 'cmid' property is a number and may be specified as:
- An int or float
@@ -130,7 +130,7 @@ def cmin(self):
Sets the lower bound of the color domain. Has an effect only if
colorsis set to a numerical array. Value should have the same
units as colors and if set, `marker.cmax` must be set as well.
-
+
The 'cmin' property is a number and may be specified as:
- An int or float
@@ -155,7 +155,7 @@ def coloraxis(self):
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
@@ -181,9 +181,9 @@ def colorbar(self):
- An instance of :class:`plotly.graph_objs.treemap.marker.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
@@ -417,7 +417,7 @@ def colors(self):
"""
Sets the color of each sector of this trace. If not specified,
the default trace color set is used to pick the sector colors.
-
+
The 'colors' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -447,14 +447,14 @@ def colorscale(self):
name string of the following list: Greys,YlGnBu,Greens,YlOrRd,B
luered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbod
y,Earth,Electric,Viridis,Cividis.
-
+
The 'colorscale' property is a colorscale and may be
specified as:
- A list of colors that will be spaced evenly to create the colorscale.
Many predefined colorscale lists are included in the sequential, diverging,
and cyclical modules in the plotly.colors package.
- A list of 2-element lists where the first element is the
- normalized color level value (starting at 0 and ending at 1),
+ 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:
@@ -490,7 +490,7 @@ def colorscale(self, val):
def colorssrc(self):
"""
Sets the source reference on Chart Studio Cloud for colors .
-
+
The 'colorssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -517,7 +517,7 @@ def depthfade(self):
is the top elements within hierarchy are drawn with fully
saturated colors while the leaves are faded towards the
background color.
-
+
The 'depthfade' property is an enumeration that may be specified as:
- One of the following enumeration values:
[True, False, 'reversed']
@@ -542,9 +542,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.treemap.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the color of the line enclosing each
sector. Defaults to the `paper_bgcolor` value.
@@ -578,9 +578,9 @@ def pad(self):
- An instance of :class:`plotly.graph_objs.treemap.marker.Pad`
- A dict of string/value properties that will be passed
to the Pad constructor
-
+
Supported dict properties:
-
+
b
Sets the padding form the bottom (in px).
l
@@ -609,7 +609,7 @@ def reversescale(self):
colorsis set to a numerical array. If true, `marker.cmin` will
correspond to the last color in the array and `marker.cmax`
will correspond to the first color.
-
+
The 'reversescale' property must be specified as a bool
(either True, or False)
@@ -630,7 +630,7 @@ def showscale(self):
"""
Determines whether or not a colorbar is displayed for this
trace. Has an effect only if colorsis set to a numerical array.
-
+
The 'showscale' property must be specified as a bool
(either True, or False)
@@ -762,7 +762,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_outsidetextfont.py b/packages/python/plotly/plotly/graph_objs/treemap/_outsidetextfont.py
index 3434bb18196..087ec2f1133 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_outsidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_outsidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Outsidetextfont object
-
+
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
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_pathbar.py b/packages/python/plotly/plotly/graph_objs/treemap/_pathbar.py
index 285881d6d9c..ef43e489d55 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_pathbar.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_pathbar.py
@@ -17,7 +17,7 @@ def edgeshape(self):
"""
Determines which shape is used for edges between `barpath`
labels.
-
+
The 'edgeshape' property is an enumeration that may be specified as:
- One of the following enumeration values:
['>', '<', '|', '\\']
@@ -41,7 +41,7 @@ def side(self):
"""
Determines on which side of the the treemap the `pathbar`
should be presented.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'bottom']
@@ -62,17 +62,17 @@ def side(self, val):
def textfont(self):
"""
Sets the font used inside `pathbar`.
-
+
The 'textfont' property is an instance of Textfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.treemap.pathbar.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 .
@@ -97,7 +97,7 @@ def textfont(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -120,7 +120,7 @@ def thickness(self):
Sets the thickness of `pathbar` (in px). If not specified the
`pathbar.textfont.size` is used with 3 pixles extra padding on
each side.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [12, inf]
@@ -141,7 +141,7 @@ def visible(self):
"""
Determines if the path bar is drawn i.e. outside the trace
`domain` and with one pixel gap.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -189,7 +189,7 @@ def __init__(
):
"""
Construct a new Pathbar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_stream.py b/packages/python/plotly/plotly/graph_objs/treemap/_stream.py
index 9e782af81c0..621f79d3110 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_textfont.py b/packages/python/plotly/plotly/graph_objs/treemap/_textfont.py
index e8a87dd9a00..d7ae9946880 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used for `textinfo`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/_tiling.py b/packages/python/plotly/plotly/graph_objs/treemap/_tiling.py
index 810786747ec..a58ca2b45ad 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/_tiling.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/_tiling.py
@@ -17,7 +17,7 @@ def flip(self):
"""
Determines if the positions obtained from solver are flipped on
each axis.
-
+
The 'flip' property is a flaglist and may be specified
as a string containing:
- Any combination of ['x', 'y'] joined with '+' characters
@@ -40,7 +40,7 @@ def packing(self):
"""
Determines d3 treemap solver. For more info please refer to
https://github.com/d3/d3-hierarchy#treemap-tiling
-
+
The 'packing' property is an enumeration that may be specified as:
- One of the following enumeration values:
['squarify', 'binary', 'dice', 'slice', 'slice-dice',
@@ -62,7 +62,7 @@ def packing(self, val):
def pad(self):
"""
Sets the inner padding (in px).
-
+
The 'pad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -92,7 +92,7 @@ def squarifyratio(self):
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.
-
+
The 'squarifyratio' property is a number and may be specified as:
- An int or float in the interval [1, inf]
@@ -140,7 +140,7 @@ def __init__(
):
"""
Construct a new Tiling object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/_font.py
index 09c85c0cb88..561b33f9706 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/_colorbar.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/_colorbar.py
index a2a5e1c0433..7131ba740cc 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/marker/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.treemap.marker.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
.colorbar.tickformatstopdefaults), sets the default property
values to use for elements of
treemap.marker.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1110,17 +1110,17 @@ def titlefont(self):
instead. Sets this color bar's title font. 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.treemap.marker.colorbar.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
@@ -1142,7 +1142,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1159,14 +1159,14 @@ def titleside(self):
instead. Determines the location of color bar's title with
respect to the color bar. Note that the title's location used
to be set by the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1180,7 +1180,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1202,7 +1202,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1223,7 +1223,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1243,7 +1243,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1265,7 +1265,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1286,7 +1286,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1555,7 +1555,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/_line.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/_line.py
index 08b15cb6cd0..7fcc9bc482b 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/_line.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the color of the line enclosing each sector. Defaults to
the `paper_bgcolor` value.
-
+
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)')
@@ -77,7 +77,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -97,7 +97,7 @@ def colorsrc(self, val):
def width(self):
"""
Sets the width (in px) of the line enclosing each sector.
-
+
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
@@ -118,7 +118,7 @@ def width(self, val):
def widthsrc(self):
"""
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
@@ -156,7 +156,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/_pad.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/_pad.py
index 376c8519dd3..43e4980a3f6 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/marker/_pad.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/_pad.py
@@ -16,7 +16,7 @@ class Pad(_BaseTraceHierarchyType):
def b(self):
"""
Sets the padding form the bottom (in px).
-
+
The 'b' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -36,7 +36,7 @@ def b(self, val):
def l(self):
"""
Sets the padding form the left (in px).
-
+
The 'l' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -56,7 +56,7 @@ def l(self, val):
def r(self):
"""
Sets the padding form the right (in px).
-
+
The 'r' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -76,7 +76,7 @@ def r(self, val):
def t(self):
"""
Sets the padding form the top (in px).
-
+
The 't' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -108,7 +108,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs):
"""
Construct a new Pad object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py
index 03398ded9cc..8c7b69ae185 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py
index fe8eeb3492a..52edadbcfc9 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_title.py
index d12c0d99222..bb841d047d9 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.treemap.marker.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/_font.py
index fb797d6b707..ea7bf4724d7 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/marker/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/treemap/pathbar/_textfont.py b/packages/python/plotly/plotly/graph_objs/treemap/pathbar/_textfont.py
index 50735af0d44..f3b2a81199a 100644
--- a/packages/python/plotly/plotly/graph_objs/treemap/pathbar/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/treemap/pathbar/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used inside `pathbar`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_box.py b/packages/python/plotly/plotly/graph_objs/violin/_box.py
index ab8aa72444f..a769ed37980 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_box.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_box.py
@@ -16,7 +16,7 @@ class Box(_BaseTraceHierarchyType):
def fillcolor(self):
"""
Sets the inner box plot fill color.
-
+
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)')
@@ -79,9 +79,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.violin.box.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the inner box plot bounding line color.
width
@@ -104,7 +104,7 @@ def visible(self):
"""
Determines if an miniature box plot is drawn inside the
violins.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -126,7 +126,7 @@ def width(self):
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.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -164,7 +164,7 @@ def __init__(
):
"""
Construct a new Box object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/violin/_hoverlabel.py
index 456ea0fefe6..51ba52206b1 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.violin.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_line.py b/packages/python/plotly/plotly/graph_objs/violin/_line.py
index 91219e702df..b9156db3dc9 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of line bounding the violin(s).
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the width (in px) of line bounding the violin(s).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_marker.py b/packages/python/plotly/plotly/graph_objs/violin/_marker.py
index 241ac08aff0..766b967d03d 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_marker.py
@@ -19,7 +19,7 @@ def color(self):
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.
-
+
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)')
@@ -82,9 +82,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.violin.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets themarker.linecolor. It accepts either a
specific color or an array of numbers that are
@@ -118,7 +118,7 @@ def line(self, val):
def opacity(self):
"""
Sets the marker opacity.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -138,7 +138,7 @@ def opacity(self, val):
def outliercolor(self):
"""
Sets the color of the outlier sample points.
-
+
The 'outliercolor' 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)')
@@ -197,7 +197,7 @@ def outliercolor(self, val):
def size(self):
"""
Sets the marker size (in px).
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -220,7 +220,7 @@ def symbol(self):
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.
-
+
The 'symbol' property is an enumeration that may be specified as:
- One of the following enumeration values:
[0, '0', 'circle', 100, '100', 'circle-open', 200, '200',
@@ -362,7 +362,7 @@ def __init__(
):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_meanline.py b/packages/python/plotly/plotly/graph_objs/violin/_meanline.py
index 7851513d47e..f51ef364291 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_meanline.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_meanline.py
@@ -16,7 +16,7 @@ class Meanline(_BaseTraceHierarchyType):
def color(self):
"""
Sets the mean line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def visible(self):
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.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -98,7 +98,7 @@ def visible(self, val):
def width(self):
"""
Sets the mean line width.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -132,7 +132,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, visible=None, width=None, **kwargs):
"""
Construct a new Meanline object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_selected.py b/packages/python/plotly/plotly/graph_objs/violin/_selected.py
index 8567472dc8e..182a6635244 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_selected.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_selected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.violin.selected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of selected points.
opacity
@@ -53,7 +53,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Selected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_stream.py b/packages/python/plotly/plotly/graph_objs/violin/_stream.py
index b0c7d4a40cf..d63a36b4556 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/_unselected.py b/packages/python/plotly/plotly/graph_objs/violin/_unselected.py
index 6970790c2f6..3ed56701f58 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/_unselected.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/_unselected.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.violin.unselected.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of unselected points,
applied only when a selection exists.
@@ -56,7 +56,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Unselected object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/box/_line.py b/packages/python/plotly/plotly/graph_objs/violin/box/_line.py
index c3d328872dd..f2e8a6cffa8 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/box/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/box/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the inner box plot bounding line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the inner box plot bounding line width.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/_font.py
index 87afd024769..f577b36b89b 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/violin/marker/_line.py b/packages/python/plotly/plotly/graph_objs/violin/marker/_line.py
index 3a517e1d51f..1ad261bc81e 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/marker/_line.py
@@ -19,7 +19,7 @@ def color(self):
an array of numbers that are mapped to the colorscale relative
to the max and min values of the array or relative to
`marker.line.cmin` and `marker.line.cmax` if set.
-
+
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)')
@@ -79,7 +79,7 @@ def outliercolor(self):
"""
Sets the border line color of the outlier sample points.
Defaults to marker.color
-
+
The 'outliercolor' 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)')
@@ -139,7 +139,7 @@ def outlierwidth(self):
"""
Sets the border line width (in px) of the outlier sample
points.
-
+
The 'outlierwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -159,7 +159,7 @@ def outlierwidth(self, val):
def width(self):
"""
Sets the width (in px) of the lines bounding the marker points.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -206,7 +206,7 @@ def __init__(
):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/selected/_marker.py b/packages/python/plotly/plotly/graph_objs/violin/selected/_marker.py
index c26f6cd4895..9f58261c807 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/selected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/selected/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of selected points.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def opacity(self):
"""
Sets the marker opacity of selected points.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -95,7 +95,7 @@ def opacity(self, val):
def size(self):
"""
Sets the marker size of selected points.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/violin/unselected/_marker.py b/packages/python/plotly/plotly/graph_objs/violin/unselected/_marker.py
index 4001e61ce5c..55ffee689f9 100644
--- a/packages/python/plotly/plotly/graph_objs/violin/unselected/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/violin/unselected/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of unselected points, applied only when a
selection exists.
-
+
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)')
@@ -77,7 +77,7 @@ def opacity(self):
"""
Sets the marker opacity of unselected points, applied only when
a selection exists.
-
+
The 'opacity' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -98,7 +98,7 @@ def size(self):
"""
Sets the marker size of unselected points, applied only when a
selection exists.
-
+
The 'size' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -131,7 +131,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_caps.py b/packages/python/plotly/plotly/graph_objs/volume/_caps.py
index f7027b3f06d..74463c0e98d 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_caps.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_caps.py
@@ -20,9 +20,9 @@ def x(self):
- An instance of :class:`plotly.graph_objs.volume.caps.X`
- A dict of string/value properties that will be passed
to the X constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `caps`. The default
fill value of the `caps` is 1 meaning that they
@@ -57,9 +57,9 @@ def y(self):
- An instance of :class:`plotly.graph_objs.volume.caps.Y`
- A dict of string/value properties that will be passed
to the Y constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `caps`. The default
fill value of the `caps` is 1 meaning that they
@@ -94,9 +94,9 @@ def z(self):
- An instance of :class:`plotly.graph_objs.volume.caps.Z`
- A dict of string/value properties that will be passed
to the Z constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `caps`. The default
fill value of the `caps` is 1 meaning that they
@@ -140,7 +140,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Caps object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_colorbar.py b/packages/python/plotly/plotly/graph_objs/volume/_colorbar.py
index c8a9d13c5cc..e0e084656e2 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_colorbar.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_colorbar.py
@@ -61,7 +61,7 @@ class ColorBar(_BaseTraceHierarchyType):
def bgcolor(self):
"""
Sets the color of padded area.
-
+
The '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)')
@@ -120,7 +120,7 @@ def bgcolor(self, val):
def bordercolor(self):
"""
Sets the axis line color.
-
+
The 'bordercolor' 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)')
@@ -179,7 +179,7 @@ def bordercolor(self, val):
def borderwidth(self):
"""
Sets the width (in px) or the border enclosing this color bar.
-
+
The 'borderwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -218,7 +218,7 @@ def dtick(self):
`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"
-
+
The 'dtick' property accepts values of any type
Returns
@@ -241,7 +241,7 @@ def exponentformat(self):
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.
-
+
The 'exponentformat' property is an enumeration that may be specified as:
- One of the following enumeration values:
['none', 'e', 'E', 'power', 'SI', 'B']
@@ -264,7 +264,7 @@ def len(self):
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.
-
+
The 'len' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -286,7 +286,7 @@ def lenmode(self):
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.
-
+
The 'lenmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -331,7 +331,7 @@ def nticks(self):
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".
-
+
The 'nticks' 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]
@@ -352,7 +352,7 @@ def nticks(self, val):
def outlinecolor(self):
"""
Sets the axis line color.
-
+
The 'outlinecolor' 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)')
@@ -411,7 +411,7 @@ def outlinecolor(self, val):
def outlinewidth(self):
"""
Sets the width (in px) of the axis line.
-
+
The 'outlinewidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -431,7 +431,7 @@ def outlinewidth(self, val):
def separatethousands(self):
"""
If "true", even 4-digit integers are separated
-
+
The 'separatethousands' property must be specified as a bool
(either True, or False)
@@ -454,7 +454,7 @@ def showexponent(self):
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.
-
+
The 'showexponent' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -475,7 +475,7 @@ def showexponent(self, val):
def showticklabels(self):
"""
Determines whether or not the tick labels are drawn.
-
+
The 'showticklabels' property must be specified as a bool
(either True, or False)
@@ -498,7 +498,7 @@ def showtickprefix(self):
"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.
-
+
The 'showtickprefix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -519,7 +519,7 @@ def showtickprefix(self, val):
def showticksuffix(self):
"""
Same as `showtickprefix` but for tick suffixes.
-
+
The 'showticksuffix' property is an enumeration that may be specified as:
- One of the following enumeration values:
['all', 'first', 'last', 'none']
@@ -541,7 +541,7 @@ def thickness(self):
"""
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
-
+
The 'thickness' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -563,7 +563,7 @@ def thicknessmode(self):
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.
-
+
The 'thicknessmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['fraction', 'pixels']
@@ -592,7 +592,7 @@ def tick0(self):
"category", it should be a number, using the scale where each
category is assigned a serial number from zero in the order it
appears.
-
+
The 'tick0' property accepts values of any type
Returns
@@ -613,7 +613,7 @@ def tickangle(self):
Sets the angle of the tick labels with respect to the
horizontal. For example, a `tickangle` of -90 draws the tick
labels vertically.
-
+
The 'tickangle' 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
@@ -635,7 +635,7 @@ def tickangle(self, val):
def tickcolor(self):
"""
Sets the tick color.
-
+
The 'tickcolor' 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)')
@@ -694,17 +694,17 @@ def tickcolor(self, val):
def tickfont(self):
"""
Sets the color bar's tick label font
-
+
The 'tickfont' property is an instance of Tickfont
that may be specified as:
- An instance of :class:`plotly.graph_objs.volume.colorbar.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
@@ -747,7 +747,7 @@ def tickformat(self):
one item to d3's date formatter: "%{n}f" for fractional seconds
with n digits. For example, *2016-10-13 09:15:23.456* with
tickformat "%H~%M~%S.%2f" would display "09~15~23.46"
-
+
The 'tickformat' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -772,9 +772,9 @@ def tickformatstops(self):
- A list or tuple of instances of plotly.graph_objs.volume.colorbar.Tickformatstop
- A list or tuple of dicts of string/value properties that
will be passed to the Tickformatstop constructor
-
+
Supported dict properties:
-
+
dtickrange
range [*min*, *max*], where "min", "max" -
dtick values which describe some zoom level, it
@@ -828,13 +828,13 @@ def tickformatstopdefaults(self):
layout.template.data.volume.colorbar.tickformatstopdefaults),
sets the default property values to use for elements of
volume.colorbar.tickformatstops
-
+
The 'tickformatstopdefaults' property is an instance of Tickformatstop
that may be specified as:
- An instance of :class:`plotly.graph_objs.volume.colorbar.Tickformatstop`
- A dict of string/value properties that will be passed
to the Tickformatstop constructor
-
+
Supported dict properties:
Returns
@@ -853,7 +853,7 @@ def tickformatstopdefaults(self, val):
def ticklen(self):
"""
Sets the tick length (in px).
-
+
The 'ticklen' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -879,7 +879,7 @@ def tickmode(self):
`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).
-
+
The 'tickmode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['auto', 'linear', 'array']
@@ -900,7 +900,7 @@ def tickmode(self, val):
def tickprefix(self):
"""
Sets a tick label prefix.
-
+
The 'tickprefix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -923,7 +923,7 @@ def ticks(self):
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.
-
+
The 'ticks' property is an enumeration that may be specified as:
- One of the following enumeration values:
['outside', 'inside', '']
@@ -944,7 +944,7 @@ def ticks(self, val):
def ticksuffix(self):
"""
Sets a tick label suffix.
-
+
The 'ticksuffix' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -967,7 +967,7 @@ def ticktext(self):
Sets the text displayed at the ticks position via `tickvals`.
Only has an effect if `tickmode` is set to "array". Used with
`tickvals`.
-
+
The 'ticktext' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -987,7 +987,7 @@ def ticktext(self, val):
def ticktextsrc(self):
"""
Sets the source reference on Chart Studio Cloud for ticktext .
-
+
The 'ticktextsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1008,7 +1008,7 @@ def tickvals(self):
"""
Sets the values at which ticks on this axis appear. Only has an
effect if `tickmode` is set to "array". Used with `ticktext`.
-
+
The 'tickvals' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -1028,7 +1028,7 @@ def tickvals(self, val):
def tickvalssrc(self):
"""
Sets the source reference on Chart Studio Cloud for tickvals .
-
+
The 'tickvalssrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -1048,7 +1048,7 @@ def tickvalssrc(self, val):
def tickwidth(self):
"""
Sets the tick width (in px).
-
+
The 'tickwidth' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1072,9 +1072,9 @@ def title(self):
- An instance of :class:`plotly.graph_objs.volume.colorbar.Title`
- A dict of string/value properties that will be passed
to the Title constructor
-
+
Supported dict properties:
-
+
font
Sets this color bar's title font. Note that the
title's font used to be set by the now
@@ -1109,17 +1109,17 @@ def titlefont(self):
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.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.volume.colorbar.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
@@ -1141,7 +1141,7 @@ def titlefont(self):
Returns
-------
-
+
"""
return self["titlefont"]
@@ -1158,14 +1158,14 @@ def titleside(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
Returns
-------
-
+
"""
return self["titleside"]
@@ -1179,7 +1179,7 @@ def titleside(self, val):
def x(self):
"""
Sets the x position of the color bar (in plot fraction).
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1201,7 +1201,7 @@ def xanchor(self):
Sets this color bar's horizontal position anchor. This anchor
binds the `x` position to the "left", "center" or "right" of
the color bar.
-
+
The 'xanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'center', 'right']
@@ -1222,7 +1222,7 @@ def xanchor(self, val):
def xpad(self):
"""
Sets the amount of padding (in px) along the x direction.
-
+
The 'xpad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1242,7 +1242,7 @@ def xpad(self, val):
def y(self):
"""
Sets the y position of the color bar (in plot fraction).
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-2, 3]
@@ -1264,7 +1264,7 @@ def yanchor(self):
Sets this color bar's vertical position anchor This anchor
binds the `y` position to the "top", "middle" or "bottom" of
the color bar.
-
+
The 'yanchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['top', 'middle', 'bottom']
@@ -1285,7 +1285,7 @@ def yanchor(self, val):
def ypad(self):
"""
Sets the amount of padding (in px) along the y direction.
-
+
The 'ypad' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -1554,7 +1554,7 @@ def __init__(
):
"""
Construct a new ColorBar object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_contour.py b/packages/python/plotly/plotly/graph_objs/volume/_contour.py
index e22ecbee3f6..fec3e48a529 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_contour.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_contour.py
@@ -16,7 +16,7 @@ class Contour(_BaseTraceHierarchyType):
def color(self):
"""
Sets the color of the contour lines.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def show(self):
"""
Sets whether or not dynamic contours are shown on hover
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -95,7 +95,7 @@ def show(self, val):
def width(self):
"""
Sets the width of the contour lines.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [1, 16]
@@ -125,7 +125,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, show=None, width=None, **kwargs):
"""
Construct a new Contour object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/volume/_hoverlabel.py
index db6d1e422b3..ef9580a9f04 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.volume.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_lighting.py b/packages/python/plotly/plotly/graph_objs/volume/_lighting.py
index 7e821387f50..b491e263c3e 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_lighting.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_lighting.py
@@ -25,7 +25,7 @@ def ambient(self):
"""
Ambient light increases overall color visibility but can wash
out the image.
-
+
The 'ambient' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -46,7 +46,7 @@ def diffuse(self):
"""
Represents the extent that incident rays are reflected in a
range of angles.
-
+
The 'diffuse' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -67,7 +67,7 @@ def facenormalsepsilon(self):
"""
Epsilon for face normals calculation avoids math issues arising
from degenerate geometry.
-
+
The 'facenormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -89,7 +89,7 @@ def fresnel(self):
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.
-
+
The 'fresnel' property is a number and may be specified as:
- An int or float in the interval [0, 5]
@@ -110,7 +110,7 @@ def roughness(self):
"""
Alters specular reflection; the rougher the surface, the wider
and less contrasty the shine.
-
+
The 'roughness' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -131,7 +131,7 @@ def specular(self):
"""
Represents the level that incident rays are reflected in a
single direction, causing shine.
-
+
The 'specular' property is a number and may be specified as:
- An int or float in the interval [0, 2]
@@ -152,7 +152,7 @@ def vertexnormalsepsilon(self):
"""
Epsilon for vertex normals calculation avoids math issues
arising from degenerate geometry.
-
+
The 'vertexnormalsepsilon' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -210,7 +210,7 @@ def __init__(
):
"""
Construct a new Lighting object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_lightposition.py b/packages/python/plotly/plotly/graph_objs/volume/_lightposition.py
index 40b4ae75667..be8ece7a31d 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_lightposition.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_lightposition.py
@@ -16,7 +16,7 @@ class Lightposition(_BaseTraceHierarchyType):
def x(self):
"""
Numeric vector, representing the X coordinate for each vertex.
-
+
The 'x' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -36,7 +36,7 @@ def x(self, val):
def y(self):
"""
Numeric vector, representing the Y coordinate for each vertex.
-
+
The 'y' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -56,7 +56,7 @@ def y(self, val):
def z(self):
"""
Numeric vector, representing the Z coordinate for each vertex.
-
+
The 'z' property is a number and may be specified as:
- An int or float in the interval [-100000, 100000]
@@ -89,7 +89,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Lightposition object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_slices.py b/packages/python/plotly/plotly/graph_objs/volume/_slices.py
index 0aaff7ee396..d50a7cc15b2 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_slices.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_slices.py
@@ -20,9 +20,9 @@ def x(self):
- An instance of :class:`plotly.graph_objs.volume.slices.X`
- A dict of string/value properties that will be passed
to the X constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `slices`. The
default fill value of the `slices` is 1 meaning
@@ -62,9 +62,9 @@ def y(self):
- An instance of :class:`plotly.graph_objs.volume.slices.Y`
- A dict of string/value properties that will be passed
to the Y constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `slices`. The
default fill value of the `slices` is 1 meaning
@@ -104,9 +104,9 @@ def z(self):
- An instance of :class:`plotly.graph_objs.volume.slices.Z`
- A dict of string/value properties that will be passed
to the Z constructor
-
+
Supported dict properties:
-
+
fill
Sets the fill ratio of the `slices`. The
default fill value of the `slices` is 1 meaning
@@ -155,7 +155,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, x=None, y=None, z=None, **kwargs):
"""
Construct a new Slices object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_spaceframe.py b/packages/python/plotly/plotly/graph_objs/volume/_spaceframe.py
index 5154b5aec17..bb702a3f702 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_spaceframe.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_spaceframe.py
@@ -19,7 +19,7 @@ def fill(self):
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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -41,7 +41,7 @@ def show(self):
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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -75,7 +75,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new Spaceframe object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_stream.py b/packages/python/plotly/plotly/graph_objs/volume/_stream.py
index dac53df3470..ae328742799 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/_surface.py b/packages/python/plotly/plotly/graph_objs/volume/_surface.py
index ac39b87c521..260f1c5dddb 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/_surface.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/_surface.py
@@ -18,7 +18,7 @@ def count(self):
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.
-
+
The 'count' 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]
@@ -42,7 +42,7 @@ def fill(self):
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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -68,7 +68,7 @@ def pattern(self):
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.
-
+
The 'pattern' property is a flaglist and may be specified
as a string containing:
- Any combination of ['A', 'B', 'C', 'D', 'E'] joined with '+' characters
@@ -91,7 +91,7 @@ def pattern(self, val):
def show(self):
"""
Hides/displays surfaces between minimum and maximum iso-values.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -140,7 +140,7 @@ def __init__(
):
"""
Construct a new Surface object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/caps/_x.py b/packages/python/plotly/plotly/graph_objs/volume/caps/_x.py
index 91ba35515bf..c7330732011 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/caps/_x.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/caps/_x.py
@@ -19,7 +19,7 @@ def fill(self):
the `caps` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def show(self):
the x `slices` 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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -78,7 +78,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new X object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/caps/_y.py b/packages/python/plotly/plotly/graph_objs/volume/caps/_y.py
index 40d07ea2419..d931c1bdbf0 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/caps/_y.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/caps/_y.py
@@ -19,7 +19,7 @@ def fill(self):
the `caps` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def show(self):
the y `slices` 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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -78,7 +78,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new Y object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/caps/_z.py b/packages/python/plotly/plotly/graph_objs/volume/caps/_z.py
index 7eb310fbb1c..ede4d43f234 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/caps/_z.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/caps/_z.py
@@ -19,7 +19,7 @@ def fill(self):
the `caps` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -42,7 +42,7 @@ def show(self):
the z `slices` 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.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -78,7 +78,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, fill=None, show=None, **kwargs):
"""
Construct a new Z object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickfont.py b/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickfont.py
index 5952a826edb..ba6ceda0c8a 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickfont.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickfont.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Tickfont object
-
+
Sets the color bar's tick label font
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickformatstop.py b/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickformatstop.py
index c4e0f50fbc1..3c57d1471b1 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickformatstop.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/colorbar/_tickformatstop.py
@@ -15,19 +15,19 @@ class Tickformatstop(_BaseTraceHierarchyType):
@property
def dtickrange(self):
"""
- range [*min*, *max*], where "min", "max" - dtick values which
- describe some zoom level, it is possible to omit "min" or "max"
- value by passing "null"
-
- The 'dtickrange' property is an info array that may be specified as:
-
- * a list or tuple of 2 elements where:
- (0) The 'dtickrange[0]' property accepts values of any type
- (1) The 'dtickrange[1]' property accepts values of any type
+ range [*min*, *max*], where "min", "max" - dtick values which
+ describe some zoom level, it is possible to omit "min" or "max"
+ value by passing "null"
- Returns
- -------
- list
+ The 'dtickrange' property is an info array that may be specified as:
+
+ * a list or tuple of 2 elements where:
+ (0) The 'dtickrange[0]' property accepts values of any type
+ (1) The 'dtickrange[1]' property accepts values of any type
+
+ Returns
+ -------
+ list
"""
return self["dtickrange"]
@@ -42,7 +42,7 @@ def enabled(self):
"""
Determines whether or not this stop is used. If `false`, this
stop is ignored even within its `dtickrange`.
-
+
The 'enabled' property must be specified as a bool
(either True, or False)
@@ -68,7 +68,7 @@ def name(self):
`name` alongside your modifications (including `visible: false`
or `enabled: false` to hide it). Has no effect outside of a
template.
-
+
The 'name' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -96,7 +96,7 @@ def templateitemname(self):
`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`.
-
+
The 'templateitemname' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -118,7 +118,7 @@ def value(self):
"""
string - dtickformat for described zoom level, the same as
"tickformat"
-
+
The 'value' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -182,7 +182,7 @@ def __init__(
):
"""
Construct a new Tickformatstop object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/colorbar/_title.py b/packages/python/plotly/plotly/graph_objs/volume/colorbar/_title.py
index a529729b896..cbc72098f0a 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/colorbar/_title.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/colorbar/_title.py
@@ -17,17 +17,17 @@ def font(self):
"""
Sets this color bar's title font. 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.volume.colorbar.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
@@ -65,7 +65,7 @@ def side(self):
Determines the location of color bar's title with respect to
the color bar. Note that the title's location used to be set by
the now deprecated `titleside` attribute.
-
+
The 'side' property is an enumeration that may be specified as:
- One of the following enumeration values:
['right', 'top', 'bottom']
@@ -88,7 +88,7 @@ def text(self):
Sets the title of the color bar. 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.
-
+
The 'text' property is a string and must be specified as:
- A string
- A number that will be converted to a string
@@ -127,7 +127,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
"""
Construct a new Title object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/_font.py b/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/_font.py
index 7ca22e17b96..5cf90e28c0a 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/colorbar/title/_font.py
@@ -84,7 +84,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
@@ -144,7 +144,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, family=None, size=None, **kwargs):
"""
Construct a new Font object
-
+
Sets this color bar's title font. Note that the title's font
used to be set by the now deprecated `titlefont` attribute.
diff --git a/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/_font.py
index b792cbaeef7..b1328fc5455 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/volume/slices/_x.py b/packages/python/plotly/plotly/graph_objs/volume/slices/_x.py
index 90388923747..458179eb0aa 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/slices/_x.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/slices/_x.py
@@ -19,7 +19,7 @@ def fill(self):
the `slices` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -41,7 +41,7 @@ def locations(self):
Specifies the location(s) of slices on the axis. When not
specified slices would be created for all points of the axis x
except start and end.
-
+
The 'locations' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -62,7 +62,7 @@ def locationssrc(self):
"""
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
@@ -83,7 +83,7 @@ def show(self):
"""
Determines whether or not slice planes about the x dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -131,7 +131,7 @@ def __init__(
):
"""
Construct a new X object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/slices/_y.py b/packages/python/plotly/plotly/graph_objs/volume/slices/_y.py
index 794e179f841..46c25291f32 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/slices/_y.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/slices/_y.py
@@ -19,7 +19,7 @@ def fill(self):
the `slices` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -41,7 +41,7 @@ def locations(self):
Specifies the location(s) of slices on the axis. When not
specified slices would be created for all points of the axis y
except start and end.
-
+
The 'locations' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -62,7 +62,7 @@ def locationssrc(self):
"""
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
@@ -83,7 +83,7 @@ def show(self):
"""
Determines whether or not slice planes about the y dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -131,7 +131,7 @@ def __init__(
):
"""
Construct a new Y object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/volume/slices/_z.py b/packages/python/plotly/plotly/graph_objs/volume/slices/_z.py
index 987f0c42796..afb6152420e 100644
--- a/packages/python/plotly/plotly/graph_objs/volume/slices/_z.py
+++ b/packages/python/plotly/plotly/graph_objs/volume/slices/_z.py
@@ -19,7 +19,7 @@ def fill(self):
the `slices` 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.
-
+
The 'fill' property is a number and may be specified as:
- An int or float in the interval [0, 1]
@@ -41,7 +41,7 @@ def locations(self):
Specifies the location(s) of slices on the axis. When not
specified slices would be created for all points of the axis z
except start and end.
-
+
The 'locations' property is an array that may be specified as a tuple,
list, numpy array, or pandas Series
@@ -62,7 +62,7 @@ def locationssrc(self):
"""
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
@@ -83,7 +83,7 @@ def show(self):
"""
Determines whether or not slice planes about the z dimension
are drawn.
-
+
The 'show' property must be specified as a bool
(either True, or False)
@@ -131,7 +131,7 @@ def __init__(
):
"""
Construct a new Z object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_connector.py b/packages/python/plotly/plotly/graph_objs/waterfall/_connector.py
index 94d7a6e5161..1ef0bf17cd7 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_connector.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_connector.py
@@ -20,9 +20,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.waterfall.connector.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color.
dash
@@ -49,7 +49,7 @@ def line(self, val):
def mode(self):
"""
Sets the shape of connector lines.
-
+
The 'mode' property is an enumeration that may be specified as:
- One of the following enumeration values:
['spanning', 'between']
@@ -70,7 +70,7 @@ def mode(self, val):
def visible(self):
"""
Determines if connector lines are drawn.
-
+
The 'visible' property must be specified as a bool
(either True, or False)
@@ -101,7 +101,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, line=None, mode=None, visible=None, **kwargs):
"""
Construct a new Connector object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_decreasing.py b/packages/python/plotly/plotly/graph_objs/waterfall/_decreasing.py
index 7bfb1ca21c6..fb8200951c5 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_decreasing.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_decreasing.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.waterfall.decreasing.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of all decreasing values.
line
@@ -53,7 +53,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Decreasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_hoverlabel.py b/packages/python/plotly/plotly/graph_objs/waterfall/_hoverlabel.py
index 7923bb20d74..c1d3eea28d5 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_hoverlabel.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_hoverlabel.py
@@ -28,7 +28,7 @@ def align(self):
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
-
+
The 'align' property is an enumeration that may be specified as:
- One of the following enumeration values:
['left', 'right', 'auto']
@@ -50,7 +50,7 @@ def align(self, val):
def alignsrc(self):
"""
Sets the source reference on Chart Studio Cloud for align .
-
+
The 'alignsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -70,7 +70,7 @@ def alignsrc(self, val):
def bgcolor(self):
"""
Sets the background color of the hover labels for this trace
-
+
The '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)')
@@ -130,7 +130,7 @@ def bgcolor(self, val):
def bgcolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for bgcolor .
-
+
The 'bgcolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -150,7 +150,7 @@ def bgcolorsrc(self, val):
def bordercolor(self):
"""
Sets the border color of the hover labels for this trace.
-
+
The 'bordercolor' 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)')
@@ -211,7 +211,7 @@ def bordercolorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for
bordercolor .
-
+
The 'bordercolorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -231,17 +231,17 @@ def bordercolorsrc(self, val):
def font(self):
"""
Sets the font used in hover labels.
-
+
The 'font' property is an instance of Font
that may be specified as:
- An instance of :class:`plotly.graph_objs.waterfall.hoverlabel.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 .
@@ -266,7 +266,7 @@ def font(self):
Sets the source reference on Chart Studio Cloud
for family .
size
-
+
sizesrc
Sets the source reference on Chart Studio Cloud
for size .
@@ -292,7 +292,7 @@ def namelength(self):
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.
-
+
The 'namelength' 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]
@@ -315,7 +315,7 @@ def namelengthsrc(self):
"""
Sets the source reference on Chart Studio Cloud for namelength
.
-
+
The 'namelengthsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -384,7 +384,7 @@ def __init__(
):
"""
Construct a new Hoverlabel object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_increasing.py b/packages/python/plotly/plotly/graph_objs/waterfall/_increasing.py
index 4465b1724bb..c8e9eaf0b8c 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_increasing.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_increasing.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.waterfall.increasing.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of all increasing values.
line
@@ -53,7 +53,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Increasing object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_insidetextfont.py b/packages/python/plotly/plotly/graph_objs/waterfall/_insidetextfont.py
index 0b4454c45fe..e1813b8bb84 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_insidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_insidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Insidetextfont object
-
+
Sets the font used for `text` lying inside the bar.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_outsidetextfont.py b/packages/python/plotly/plotly/graph_objs/waterfall/_outsidetextfont.py
index 5aec6e2b10e..3569847ba47 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_outsidetextfont.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_outsidetextfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Outsidetextfont object
-
+
Sets the font used for `text` lying outside the bar.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_stream.py b/packages/python/plotly/plotly/graph_objs/waterfall/_stream.py
index ad5ff98cb0c..376954dcd02 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_stream.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_stream.py
@@ -18,7 +18,7 @@ def maxpoints(self):
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.
-
+
The 'maxpoints' property is a number and may be specified as:
- An int or float in the interval [0, 10000]
@@ -40,7 +40,7 @@ def token(self):
The stream id number links a data trace on a plot with a
stream. See https://chart-studio.plotly.com/settings for more
details.
-
+
The 'token' property is a string and must be specified as:
- A non-empty string
@@ -73,7 +73,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
"""
Construct a new Stream object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_textfont.py b/packages/python/plotly/plotly/graph_objs/waterfall/_textfont.py
index 7f907565330..92c2b4dddab 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_textfont.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_textfont.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Textfont object
-
+
Sets the font used for `text`.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/_totals.py b/packages/python/plotly/plotly/graph_objs/waterfall/_totals.py
index 5d9af9da124..e7ca7694b1c 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/_totals.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/_totals.py
@@ -20,9 +20,9 @@ def marker(self):
- An instance of :class:`plotly.graph_objs.waterfall.totals.Marker`
- A dict of string/value properties that will be passed
to the Marker constructor
-
+
Supported dict properties:
-
+
color
Sets the marker color of all intermediate sums
and total values.
@@ -54,7 +54,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, marker=None, **kwargs):
"""
Construct a new Totals object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/connector/_line.py b/packages/python/plotly/plotly/graph_objs/waterfall/connector/_line.py
index 7427a7c40c1..6867372355b 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/connector/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/connector/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color.
-
+
The 'color' property is a color and may be specified as:
- A hex string (e.g. '#ff0000')
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
@@ -78,7 +78,7 @@ def dash(self):
("solid", "dot", "dash", "longdash", "dashdot", or
"longdashdot") or a dash length list in px (eg
"5px,10px,2px,2px").
-
+
The 'dash' property is a string and must be specified as:
- One of the following strings:
['solid', 'dot', 'dash', 'longdash', 'dashdot',
@@ -101,7 +101,7 @@ def dash(self, val):
def width(self):
"""
Sets the line width (in px).
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -134,7 +134,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/_marker.py b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/_marker.py
index 3cc89b899c6..11293b5ce2b 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of all decreasing values.
-
+
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)')
@@ -79,9 +79,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.waterfall.decreasing.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color of all decreasing values.
width
@@ -112,7 +112,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, line=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/_line.py b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/_line.py
index f450097c062..6b44b44074f 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/decreasing/marker/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color of all decreasing values.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the line width of all decreasing values.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/_font.py b/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/_font.py
index dd98dff906e..083a5d873e4 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/_font.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/hoverlabel/_font.py
@@ -74,7 +74,7 @@ def color(self, val):
def colorsrc(self):
"""
Sets the source reference on Chart Studio Cloud for color .
-
+
The 'colorsrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -105,7 +105,7 @@ def family(self):
"Droid Sans",, "Droid Serif", "Droid Sans Mono", "Gravitas
One", "Old Standard TT", "Open Sans", "Overpass", "PT Sans
Narrow", "Raleway", "Times New Roman".
-
+
The 'family' property is a string and must be specified as:
- A non-empty string
- A tuple, list, or one-dimensional numpy array of the above
@@ -126,7 +126,7 @@ def family(self, val):
def familysrc(self):
"""
Sets the source reference on Chart Studio Cloud for family .
-
+
The 'familysrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -165,7 +165,7 @@ def size(self, val):
def sizesrc(self):
"""
Sets the source reference on Chart Studio Cloud for size .
-
+
The 'sizesrc' property must be specified as a string or
as a plotly.grid_objs.Column object
@@ -226,7 +226,7 @@ def __init__(
):
"""
Construct a new Font object
-
+
Sets the font used in hover labels.
Parameters
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/_marker.py b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/_marker.py
index f4f25a0edcc..361e73bd819 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/_marker.py
@@ -16,7 +16,7 @@ class Marker(_BaseTraceHierarchyType):
def color(self):
"""
Sets the marker color of all increasing values.
-
+
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)')
@@ -79,9 +79,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.waterfall.increasing.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color of all increasing values.
width
@@ -112,7 +112,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, line=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/_line.py b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/_line.py
index 615bbbefd7c..11fa42bd9e5 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/increasing/marker/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color of all increasing values.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the line width of all increasing values.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -103,7 +103,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/totals/_marker.py b/packages/python/plotly/plotly/graph_objs/waterfall/totals/_marker.py
index a90d0910322..82c8aa99820 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/totals/_marker.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/totals/_marker.py
@@ -17,7 +17,7 @@ def color(self):
"""
Sets the marker color of all intermediate sums and total
values.
-
+
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)')
@@ -80,9 +80,9 @@ def line(self):
- An instance of :class:`plotly.graph_objs.waterfall.totals.marker.Line`
- A dict of string/value properties that will be passed
to the Line constructor
-
+
Supported dict properties:
-
+
color
Sets the line color of all intermediate sums
and total values.
@@ -116,7 +116,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, line=None, **kwargs):
"""
Construct a new Marker object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/_line.py b/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/_line.py
index 95973c0331b..e064fc90036 100644
--- a/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/_line.py
+++ b/packages/python/plotly/plotly/graph_objs/waterfall/totals/marker/_line.py
@@ -16,7 +16,7 @@ class Line(_BaseTraceHierarchyType):
def color(self):
"""
Sets the line color of all intermediate sums and total values.
-
+
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)')
@@ -75,7 +75,7 @@ def color(self, val):
def width(self):
"""
Sets the line width of all intermediate sums and total values.
-
+
The 'width' property is a number and may be specified as:
- An int or float in the interval [0, inf]
@@ -105,7 +105,7 @@ def _prop_descriptions(self):
def __init__(self, arg=None, color=None, width=None, **kwargs):
"""
Construct a new Line object
-
+
Parameters
----------
arg
diff --git a/packages/python/plotly/plotly/tests/test_core/test_errors/test_dict_path_errors.py b/packages/python/plotly/plotly/tests/test_core/test_errors/test_dict_path_errors.py
new file mode 100644
index 00000000000..37f522520d9
--- /dev/null
+++ b/packages/python/plotly/plotly/tests/test_core/test_errors/test_dict_path_errors.py
@@ -0,0 +1,223 @@
+import plotly.graph_objects as go
+from _plotly_utils.exceptions import PlotlyKeyError
+import pytest
+
+
+def error_substr(s, r):
+ """ remove a part of the error message we don't want to compare """
+ return s.replace(r, "")
+
+
+@pytest.fixture
+def some_fig():
+ fig = go.Figure()
+ fig.add_trace(go.Scatter(x=[], y=[]))
+ fig.add_shape(type="rect", x0=1, x1=2, y0=3, y1=4)
+ fig.add_shape(type="rect", x0=10, x1=20, y0=30, y1=40)
+ fig.add_trace(go.Scatter(x=[1, 2, 3], y=[4, 5, 6]))
+ return fig
+
+
+def test_raises_on_bad_index(some_fig):
+ # Check indexing errors can be detected when path used as key to go.Figure
+ try:
+ x0 = some_fig["layout.shapes[2].x0"]
+ except IndexError as e:
+ assert (
+ e.args[0].find(
+ """Bad property path:
+layout.shapes[2].x0
+ ^"""
+ )
+ >= 0
+ )
+
+
+def test_raises_on_bad_dot_property(some_fig):
+
+ # Check . property lookup errors can be detected when path used as key to
+ # go.Figure
+ try:
+ x2000 = some_fig["layout.shapes[1].x2000"]
+ except ValueError as e:
+ assert (
+ e.args[0].find(
+ """Bad property path:
+layout.shapes[1].x2000
+ ^"""
+ )
+ >= 0
+ )
+
+
+def test_raises_on_bad_ancestor_dot_property(some_fig):
+
+ # Check . property lookup errors but not on the last part of the path
+ try:
+ x2000 = some_fig["layout.shapa[1].x2000"]
+ except ValueError as e:
+ assert (
+ e.args[0].find(
+ """Bad property path:
+layout.shapa[1].x2000
+ ^"""
+ )
+ >= 0
+ )
+
+
+def test_raises_on_bad_indexed_underscore_property(some_fig):
+
+ # finds bad part when using the path as a key to figure and throws the error
+ # for the last good property it found in the path
+ try:
+ # get the error without using a path-like key, we compare with this error
+ some_fig.data[0].line["colr"] = "blue"
+ except ValueError as e_correct:
+ # remove "Bad property path:
+ e_correct_substr = error_substr(
+ e_correct.args[0],
+ """
+Bad property path:
+colr
+^""",
+ )
+ # if the string starts with "Bad property path:" then this test cannot work
+ # this way.
+ assert len(e_correct_substr) > 0
+ try:
+ some_fig["data[0].line_colr"] = "blue"
+ except ValueError as e:
+ e_substr = error_substr(
+ e.args[0],
+ """
+Bad property path:
+data[0].line_colr
+ ^""",
+ )
+ assert (
+ (
+ e.args[0].find(
+ """Bad property path:
+data[0].line_colr
+ ^"""
+ )
+ >= 0
+ )
+ and (e_substr == e_correct_substr)
+ )
+
+ try:
+ # get the error without using a path-like key
+ some_fig.add_trace(go.Scatter(x=[1, 2], y=[3, 4], line=dict(colr="blue")))
+ except ValueError as e_correct:
+ e_correct_substr = error_substr(
+ e_correct.args[0],
+ """
+Bad property path:
+colr
+^""",
+ )
+ # finds bad part when using the path as a keyword argument to a subclass of
+ # BasePlotlyType and throws the error for the last good property found in
+ # the path
+ try:
+ some_fig.add_trace(go.Scatter(x=[1, 2], y=[3, 4], line_colr="blue"))
+ except ValueError as e:
+ e_substr = error_substr(
+ e.args[0],
+ """
+Bad property path:
+line_colr
+ ^""",
+ )
+ assert (
+ (
+ e.args[0].find(
+ """Bad property path:
+line_colr
+ ^"""
+ )
+ >= 0
+ )
+ and (e_substr == e_correct_substr)
+ )
+
+ # finds bad part when using the path as a keyword argument to a subclass of
+ # BaseFigure and throws the error for the last good property found in
+ # the path
+ try:
+ fig2 = go.Figure(layout=dict(title=dict(txt="two")))
+ except ValueError as e_correct:
+ e_correct_substr = error_substr(
+ e_correct.args[0],
+ """
+Bad property path:
+txt
+^""",
+ )
+
+ try:
+ fig2 = go.Figure(layout_title_txt="two")
+ except TypeError as e:
+ # when the Figure constructor sees the same ValueError above, a
+ # TypeError is raised and adds an error message in front of the same
+ # ValueError thrown above
+ e_substr = error_substr(
+ e.args[0],
+ """
+Bad property path:
+layout_title_txt
+ ^""",
+ )
+ # also remove the invalid Figure property string added by the Figure constructor
+ e_substr = error_substr(
+ e_substr,
+ """invalid Figure property: layout_title_txt
+""",
+ )
+ assert (
+ (
+ e.args[0].find(
+ """Bad property path:
+layout_title_txt
+ ^"""
+ )
+ >= 0
+ )
+ and (e_substr == e_correct_substr)
+ )
+
+ # this is like the above test for subclasses of BasePlotlyType but makes sure it
+ # works when the bad part is not the last part in the path
+ try:
+ some_fig.update_layout(geo=dict(ltaxis=dict(showgrid=True)))
+ except ValueError as e_correct:
+ e_correct_substr = error_substr(
+ e_correct.args[0],
+ """
+Bad property path:
+ltaxis
+^""",
+ )
+ try:
+ some_fig.update_layout(geo_ltaxis_showgrid=True)
+ except ValueError as e:
+ e_substr = error_substr(
+ e.args[0],
+ """
+Bad property path:
+geo_ltaxis_showgrid
+ ^ """,
+ )
+ assert (
+ (
+ e.args[0].find(
+ """Bad property path:
+geo_ltaxis_showgrid
+ ^"""
+ )
+ >= 0
+ )
+ and (e_substr == e_correct_substr)
+ )
diff --git a/packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_layout_subplots.py b/packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_layout_subplots.py
index 037d2384983..0217f7c236c 100644
--- a/packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_layout_subplots.py
+++ b/packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_layout_subplots.py
@@ -39,7 +39,7 @@ def test_initial_access_subplot2(self):
self.layout.xaxis2
def test_initial_access_subplot2(self):
- with pytest.raises(KeyError):
+ with pytest.raises(ValueError):
self.layout["xaxis2"]
def test_assign_subplots(self):